Overview
Menu

DescribeRules

1. API Description

Domain name for API request: teo.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeRules.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site
Filters.NNoArray of FilterFilter 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 NameTypeDescription
    ZoneIdStringID of the site
    RuleItemsArray of RuleItemList of rules. Rules are sorted in order of execution.
    RequestIdStringThe 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.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.

    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 CodeDescription
    InternalError.RouteErrorThe backend routing address is incorrect.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnauthorizedOperation.UnknownAn unknown error occurred in the backend server.