tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Web Application Firewall
    Documentation
    Download PDF

    DescribeCCRuleList

    Last updated: 2024-09-25 10:12:50
    Download PDF

    1. API Description

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

    Query CC rules based on multiple conditions

    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: DescribeCCRuleList.
    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, ap-singapore.
    Domain Yes String Domain name of the API to be queried
    Offset Yes Integer Offset
    Limit Yes Integer Capacity
    By Yes String Currently supports sorting by ts_version
    Filters.N No Array of FiltersItemNew Filter array. A name can be one of the following values: RuleID, ParamName, Url, Action, Method, Source, and Status.
    Order No String asc or desc

    3. Output Parameters

    Parameter Name Type Description
    Data CCRuleLists List of CC rules found

    Note: This field may return null, indicating that no valid values can be obtained.
    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 test1

    Input Example

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



{
    "By": "ts_version",
    "Domain": "hzh.qcloud.com",
    "Limit": "10",
    "Order": "asc",
    "Offset": "10000002"
}

    Output Example

    {
    "Response": {
        "RequestId": "41b55f8b-1ed1-484c-aab7-c14c0889f78b",
        "Data": {
            "Res": [
                {
                    "Name": "test",
                    "Status": 0,
                    "Advance": 0,
                    "Limit": 2,
                    "Interval": 60,
                    "Url": "/",
                    "MatchFunc": 0,
                    "ActionType": 22,
                    "Priority": 50,
                    "ValidTime": 600,
                    "TsVersion": 1609769256761,
                    "Options": "[]",
                    "RuleId": 0,
                    "EventId": "11"
                },
                {
                    "Name": "ddp",
                    "Status": 0,
                    "Advance": 0,
                    "Limit": 10,
                    "Interval": 10,
                    "Url": "/test",
                    "MatchFunc": 0,
                    "ActionType": 20,
                    "Priority": 1,
                    "ValidTime": 61,
                    "TsVersion": 1669794335102,
                    "Options": "",
                    "RuleId": 1900009616,
                    "EventId": "111"
                }
            ],
            "TotalCount": 2
        }
    }
}

    Example2 Querying an API Security Rule Based on a URL

    Input Example

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



{
    "Domain": "www.testwaf.com",
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "clb",
                "saas"
            ],
            "Name": "InstanceType",
            "ExactMatch": true
        }
    ],
    "Offset": 1,
    "By": "ts_version"
}

    Output Example

    {
    "Response": {
        "Data": {
            "Res": [
                {
                    "ActionType": 22,
                    "Advance": 0,
                    "Interval": 60,
                    "Limit": 60,
                    "MatchFunc": 0,
                    "Name": "test1",
                    "Priority": 50,
                    "Status": 1,
                    "TsVersion": 1579058116920,
                    "Url": "///",
                    "ValidTime": 600,
                    "Options": "",
                    "RuleId": 1900009616,
                    "EventId": "111"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "1cc54bf4-cfeb-40cc-a823-035e52106df9"
    }
}

    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.
    UnsupportedOperation The operation is not supported.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy