tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRiskDnsPolicyList

Last updated: 2024-08-27 11:41:52

1. API Description

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

This API is used to obtain the list of malicious request policies.

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: DescribeRiskDnsPolicyList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filters.N No Array of Filter
  • PolicyType - int - required: no - policy type
  • PolicyName - string - required: no - policy name
  • Domain - string - required: no - domain name (URL encoding and then Base64 encoding on the domain name)
  • PolicyAction - int - required: no - policy action
  • IsEnabled - int - required: no - whether the policy is enabled
    		•
    Limit No Integer Limit Entries, 10 by default, up to 100
    Offset No Integer Offset, which is 0 by default.
    Order No String Sorting Method: [ASC: Ascending Order, DESC: Descending Order]
    By No String Sorting column: [HostScope|UpdateTime]

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number
    List Array of RiskDnsPolicy Data list
    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 Getting Malicious Request Policy List

    Input Example

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

{
    "Limit": 10
}

    Output Example

    {
    "Response": {
        "List": [
            {
                "PolicyId": 1001,
                "PolicyName": "System rule (important period guarantee)",
                "PolicyType": 0,
                "PolicyDesc": "System rule (important period guarantee)",
                "PolicyAction": 0,
                "HostScope": 1,
                "HostIds": [],
                "Domains": [
                    ""
                ],
                "IsEnabled": 1,
                "IsDealOldEvent": 0,
                "EventId": 0,
                "UpdateTime": "2022-09-19 17:12:01"
            }
        ],
        "RequestId": "a8a04837-4318-4a21-8a05-7096ed84062c",
        "TotalCount": 21
    }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy