Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the list of available custom configurations for rule engine operations on a site.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeAvailableCustomActionsForRuleEngine. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Zone ID. |
| Filters.N | No | Array of AdvancedFilter | Filter criteria. Multiple conditions have an AND relationship. The maximum number of Filters.Values is 20. If this parameter is left empty, return all available rule engine custom configurations under the current site. Detailed filter criteria: name. |
| Limit | No | Integer | Paginated query limit. Value ranges from 0 to 1000. Default value: 20. |
| Offset | No | Integer | Paging offset. Default value: 0. |
| SortBy | No | String | Sorting field. Valid values: action-id. |
| SortOrder | No | String | Sorting method. Valid values: |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible rule engine custom configurations. |
| CustomActionSet | Array of RuleEngineCustomAction | List of eligible rule engine custom configurations. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query the list of custom configurations available for the rule engine at the site.
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAvailableCustomActionsForRuleEngine
<Common request parameters>
{
"ZoneId": "zone-3**********x",
"Filters": [
{
"Name": "action-id",
"Values": [
"ca-3**********n"
]
}
],
"Limit": 1,
"Offset": 0,
"SortBy": "action-id",
"SortOrder": "desc"
}{
"Response": {
"CustomActionSet": [
{
"ActionId": "ca-3**********n",
"Description": "Rate limiting for client IP access.",
"Name": "ClientIPRateLimit",
"Parameters": [
{
"Default": "100",
"Description": "The maximum QPS of the client IP",
"MaxValue": 10000,
"MinValue": 1,
"Name": "MaxQPS",
"Required": false,
"ValueType": "Integer"
}
],
"SupportedConditions": [
"http.request.host"
]
}
],
"TotalCount": 1,
"RequestId": "bbd3abd8-aeb6-4ca5-a623-6502f8f19c1a"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.ZoneNotFound | No corresponding site. please ensure correct information entry. |
文档反馈