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.
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)]; |
| 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. |
https://dayu.tencentcloudapi.com/?Action=DescribeCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Type.0=black
&Protocol=http
&<Common request parameters>{
"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
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?