DescribeRules
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the rules in the rule engine.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeRules. |
| 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 | ID of the site |
| Filters.N | No | Array of Filter | Filter conditions. Each filter condition can have up to 20 entries. See below for details:rule-id:Filter by the rule ID Type: String Required: No |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ZoneId | String | ID of the site |
| RuleItems | Array of RuleItem | List of rules. Rules are sorted in order of execution. |
| 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. |
4. Example
Example1 DescribeRules
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRules
<Common request parameters>
{
"ZoneId": "zone-kwsqufps"
}
Output Example
{
"Response": {
"RequestId": "5f24d792-050d-439f-a864-353fd7b67e9f",
"RuleItems": [
{
"RuleId": "rule-2picazk4qsq9",
"RuleName": "Unnamed rule",
"RulePriority": 1,
"Rules": [
{
"Actions": [
{
"CodeAction": null,
"NormalAction": {
"Action": "Cache",
"Parameters": [
{
"Name": "Type",
"Values": [
"Cache"
]
},
{
"Name": "Switch",
"Values": [
"on"
]
},
{
"Name": "IgnoreCacheControl",
"Values": [
"off"
]
},
{
"Name": "CacheTime",
"Values": [
"100"
]
}
]
},
"RewriteAction": null
}
],
"Conditions": [
{
"Conditions": [
{
"IgnoreCase": false,
"IgnoreNameCase": false,
"Operator": "equal",
"Target": "host",
"Name": "",
"Values": [
"corki.chris-v.com"
]
}
]
}
],
"SubRules": []
}
],
"Status": "enable",
"Tags": []
}
],
"ZoneId": "zone-2p7d5y3b8l8k"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.RouteError | The backend routing address is incorrect. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |