tencent cloud

Feedback

DescribeCcGeoIPBlockConfigList

Last updated: 2023-05-24 14:57:54

1. API Description

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

This API is used to obtain a list of regional blocking configurations.

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: DescribeCcGeoIPBlockConfigList.
Version Yes String Common Params. The value used for this API: 2020-03-09.
Region No String Common Params. This parameter is not required for this API.
Business Yes String Anti-DDoS service type. Valid values: bgpip-multip (Anti-DDoS Pro) and bgpip (Anti-DDoS Advanced).
Offset Yes Integer Starting offset of the page. Value: (number of pages – 1) * items per page.
Limit Yes Integer Number of results returned in one page
InstanceId No String Instance ID
Ip No String IP address, which is required when an Anti-DDoS Advanced instance is used.
Domain No String Domain name, which is required when an Anti-DDoS Advanced instance is used.
Protocol No String Protocol, which is required when an Anti-DDoS Advanced instance is used.

3. Output Parameters

Parameter Name Type Description
Total Integer Number of policy lists
CcGeoIpPolicyList Array of CcGeoIpPolicyNew Information of the policy list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining a list of regional blocking configurations

Input Example

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

{
    "Domain": "test.dayu.com",
    "Protocol": "http",
    "Business": "bgpip",
    "InstanceId": "bgpip-111111q1",
    "Ip": "1.1.1.1",
    "Limit": 1,
    "Offset": 1
}

Output Example

{
    "Response": {
        "CcGeoIpPolicyList": [
            {
                "Domain": "test.dayu.com",
                "Protocol": "http",
                "InstanceId": "bgpip-111111q1",
                "Ip": "1.1.1.1",
                "RegionType": "china",
                "PolicyId": "rule-0000011x",
                "ModifyTime": "2020-09-22 00:00:00",
                "Action": "1",
                "CreateTime": "2020-09-22 00:00:00",
                "AreaList": [
                    1
                ]
            }
        ],
        "Total": 1,
        "RequestId": "c9520936-381c-4c04-b535-c8f4df1f8059"
    }
}

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
LimitExceeded The quota limit should not be exceeded.
ResourceNotFound The resource does not exist. Please try again later.
UnsupportedOperation Unsupported operation.
Contact Us

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

Technical Support

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

7x24 Phone Support