tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCustomRuleList

Last updated: 2024-11-27 09:46:41

1. API Description

Domain name for API request: waf.intl.tencentcloudapi.com.

Obtain the access control policy list in the protection configuration

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: DescribeCustomRuleList.
Version Yes String Common Params. The value used for this API: 2018-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul.
Domain Yes String Domain name
Offset Yes Integer Offset
Limit Yes Integer Capacity
Filters.N No Array of FiltersItemNew Filter array. A name can be one of the following: RuleID, RuleName, and Match.
Order No String asc or desc
By No String exp_ts or mod_ts
DomainList.N No Array of String Domain name list to query. This parameter is not required on the access control page.

3. Output Parameters

Parameter Name Type Description
RuleList Array of DescribeCustomRulesRspRuleListItem Rule details
TotalCount String Number of rules
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 Obtaining the Access Control Rule List

Input Example

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



{
    "Domain": "test.qcloudwaf.com",
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "1234567890"
            ],
            "Name": "RuleID",
            "ExactMatch": true
        }
    ],
    "Offset": 1
}

Output Example

{
    "Response": {
        "RequestId": "6a638b80-87db-458d-9dd8-461bb38d960a",
        "RuleList": [
            {
                "ActionType": "1",
                "Bypass": "cc",
                "CreateTime": "2024-07-29T18:55:42+08:00",
                "ExpireTime": "0",
                "Name": "rulename",
                "Redirect": "/redirect_url",
                "RuleId": "1101205922",
                "SortId": "50",
                "Status": "1",
                "Strategies": [
                    {
                        "Field": "COOKIE",
                        "CompareFunc": "eq",
                        "Content": "cookie_value",
                        "Arg": "cookie_key",
                        "CaseNotSensitive": 0
                    }
                ],
                "EventId": "1101",
                "ValidStatus": 1,
                "ModifyTime": "2024-08-28T18:54:25+08:00",
                "Source": "custom",
                "JobType": "TimedJob",
                "JobDateTime": {
                    "Timed": [
                        {
                            "StartDateTime": 0,
                            "EndDateTime": 0
                        }
                    ],
                    "Cron": [],
                    "TimeTZone": "UTC+8"
                },
                "CronType": "week",
                "Label": "label",
                "PageId": "1101",
                "Domain": "www.testwaf.com"
            }
        ],
        "TotalCount": "1"
    }
}

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
InternalError Internal error.
InternalError.DBErr DBErr
InvalidParameter Parameter error.
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy