tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBotManagedRules

Last updated: 2022-11-28 16:50:35
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query a bot managed rule.

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-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset Yes Integer The page offset. Default value: 0
Limit Yes Integer The paginated query limit. Default value: 20. Maximum value: 1000.
ZoneId No String The site ID. You must specify either "ZoneId+Entity" or "TemplateId".
Entity No String The subdomain name/L4 proxy. You must specify either "ZoneId+Entity" or "TemplateId".
RuleType No String The rule type. Values:
  • idcid
  • sipbot
  • uabot
    • If no value or 0 is passed, all rule types will be selected.
    TemplateId No String The template ID. You must specify either "ZoneId+Entity" or "TemplateId".

    3. Output Parameters

    Parameter Name Type Description
    Count Integer Number of bot managed rules returned.
    BotManagedRuleDetails Array of BotManagedRuleDetail The bot managed rule.
    Total Integer The 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 list of bot managed rules

    Input Example

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

{
    "RuleType": "",
    "Offset": 2,
    "Entity": "a.eotest.com",
    "Limit": 1,
    "ZoneId": "zone-285thql0vdhi"
}

    Output Example

    {
    "Response": {
        "RequestId": "c1e7056d-ed79-4b24-b791-aaa3ccadc6ee",
        "Count": 2,
        "BotManagedRuleDetails": [
            {
                "Description": "Uncategorised",
                "RuleId": 1000,
                "RuleTypeName": "uabot",
                "Status": "block"
            },
            {
                "Description": "Feed checker",
                "RuleId": 1001,
                "RuleTypeName": "uabot",
                "Status": "block"
            }
        ],
        "Total": 1500
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy