tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCcBlackWhiteIpList

Last updated: 2024-07-01 09:54:58

    1. API Description

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

    This API is used to obtain the layer-4 access control list.

    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: DescribeCcBlackWhiteIpList.
    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).
    InstanceId Yes String Instance ID
    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
    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.
    FilterIp No String Specifies a blocklist/allowlist IP.
    FilterType No String Specifies whether is an IP blocklist or IP allowlist.

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Number of policy lists
    CcBlackWhiteIpList Array of CcBlackWhiteIpPolicy Information of the policy list
    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 Obtaining a layer-4 access control list

    Input Example

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

{
    "Domain": "www.test1.com",
    "Protocol": "https",
    "Business": "bgpip",
    "InstanceId": "bgpip-000000z9",
    "Ip": "1.1.1.1",
    "Limit": 1,
    "Offset": 1
}

    Output Example

    {
    "Response": {
        "Total": 1,
        "CcBlackWhiteIpList": [
            {
                "Domain": "www.test1.com",
                "BlackWhiteIp": "2.2.2.2",
                "Protocol": "https",
                "InstanceId": "bgpip-000004z9",
                "Ip": "1.1.1.1",
                "Mask": 1,
                "PolicyId": "ccBlackWhite-000002s7",
                "ModifyTime": "2022-04-30 08:09:20",
                "Type": "white",
                "CreateTime": "2022-04-30 07:09:20"
            }
        ],
        "RequestId": "1be9f39c-7060-11ed-aae2-525400f921f0"
    }
}

    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.
    ResourceUnavailable The resource is unavailable.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy