DescribeCCIpAllowDeny

Last updated: 2020-07-31 10:09:09

1. API Description

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

This API is used to get the CC IP blocklist/allowlist.

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 parameter. The value used for this API: DescribeCCIpAllowDeny.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Business Yes String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; bgp: Anti-DDoS Pro (single IP); bgp-multip: Anti-DDoS Pro (multi-IP), net: Anti-DDoS Ultimate
Id Yes String Anti-DDoS instance ID
Type.N Yes Array of String Blocklist or allowlist. Valid values: [white (allowlist), black (blocklist)]
Note: this array can only have one value. It cannot get the blocklist and allowlist at the same time
Limit No Integer Pagination parameter
Offset No Integer Pagination parameter
Protocol No String HTTP or HTTPS CC protection, which is optional. Valid values: [http (HTTP CC protection), https (HTTPS CC protection)];

3. Output Parameters

Parameter Name Type Description
Data Array of KeyValue This field has been replaced by RecordList and should not be used
Total Integer Number of records
RecordList Array of KeyValueRecord Returned Blocklist/allowlist record,
If "Key":"ip", "Value": IP;
If "Key":"domain", "Value": domain name.
If "Key":"type", "Value" can be white (allowlist) or black (blocklist).
If "Key":"protocol", "Value": CC protection protocol (HTTP or HTTPS);
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting IP blacklist/whitelist for CC protection

Input Example

https://dayu.tencentcloudapi.com/?Action=DescribeCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Type.0=black
&Protocol=http
&<Common request parameters>

Output Example

{
  "Response": {
    "Data": [
      {
        "Key": "white",
        "Value": "123.20.10.0/24,1.1.11.1"
      },
      {
        "Key": "total",
        "Value": "2"
      }
    ],
    "RecordList": [
      {
        "Record": [
          {
            "Key": "ip",
            "Value": "123.20.10.0/24"
          },
          {
            "Key": "domain",
            "Value": ""
          },
          {
            "Key": "protocol",
            "Value": "http"
          },
          {
            "Key": "type",
            "Value": "white"
          }
        ]
      },
      {
        "Record": [
          {
            "Key": "ip",
            "Value": "1.1.11.1"
          },
          {
            "Key": "domain",
            "Value": ""
          },
          {
            "Key": "protocol",
            "Value": "http"
          },
          {
            "Key": "type",
            "Value": "white"
          }
        ]
      }
    ],
    "RequestId": "40fc168e-a7c1-4bdc-92b9-d5b3f88369a9",
    "Total": 2
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help