tencent cloud

Feedback

DescribeSecurityRuleId

Last updated: 2022-10-19 18:00:44
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 security 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: DescribeSecurityRuleId.
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.
RuleIdList.N Yes Array of Integer Array of rule IDs.
RuleType Yes String Rule type. Values:
  • waf: Web managed rules
  • acl: Custom rules
  • rate: Rate limiting rules
  • bot: Bot managed rules
  • Entity No String The subdomain name/layer-4 proxy.

    3. Output Parameters

    Parameter Name Type Description
    WafGroupRules Array of WafGroupRule List of rules.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the details of a bot managed rule

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeSecurityRuleId
    <Common request parameters>
    
    {
        "RuleType": "bot",
        "RuleIdList": [
            "1006"
        ],
        "Entity": "runtimewu.eosecdev.xyz"
    }
    

    Output Example

    {
        "Response": {
            "WafGroupRules": [
                {
                    "Status": "allow",
                    "UpdateTime": "2022-09-01 00:00:00",
                    "Description": "Site Monitor",
                    "RuleId": 1006,
                    "RuleTypeId": 0,
                    "RuleLevelDesc": "Site Monitor",
                    "RuleTypeName": "Site Monitor",
                    "RuleTags": [
                        "site"
                    ],
                    "RuleTypeDesc": "Site Monitor"
                }
            ],
            "RequestId": "awj989f2j-afj9hf8-dj293d"
        }
    }
    

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    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