tencent cloud

Feedback

DescribeBotManagedRules

Last updated: 2022-09-01 15:05:30

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to query bot managed rules.

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: DescribeBotManagedRules.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String Top-level domain name
Entity Yes String Subdomain name/layer-4 proxy
Page Yes Integer Total number of pages
PerPage Yes Integer Number of rules per page
RuleType No String Rule type. Values: idcid, sipbot and uabot. All rules will be returned if this field is not specified.

3. Output Parameters

Parameter Name Type Description
Count Integer Number of bot managed rules returned
Rules Array of BotManagedRuleDetail Bot managed rules
Total Integer Total number of bot managed rules
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying a managed rule

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBotManagedRules
<Common request parameters>

{
    "PerPage": 0,
    "Entity": "xx",
    "Page": 0,
    "ZoneId": "xx"
}

Output Example

{
    "Response": {
        "Count": 0,
        "Rules": [
            {
                "Status": "xx",
                "RuleTypeName": "xx",
                "Description": "xx",
                "RuleId": 0
            }
        ],
        "Total": 0,
        "RequestId": "xx"
    }
}

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 Code Description
InvalidParameter.Security Invalid parameter.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support