tencent cloud

文档反馈

DescribeListBlackWhiteIpList

最后更新时间:2024-07-01 09:54:55

    1. API Description

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

    This API is used to get a list of Anti-DDoS IP blocklists/allowlists.

    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: DescribeListBlackWhiteIpList.
    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.
    Offset Yes Integer Starting offset of the page. Value: (number of pages – 1) * items per page.
    Limit Yes Integer Number of items per page. The default value is 20 when Limit = 0. The maximum value is 100.
    FilterInstanceId Yes String Anti-DDoS instance ID filter. Anti-DDoS instance prefix wildcard search is supported. For example, you can filter Anti-DDoS Pro instances by bgp-*.
    FilterIp No String IP filter

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total number of lists
    IpList Array of BlackWhiteIpRelation IP blocklist/allowlist
    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 the Anti-DDoS IP blocklist/allowlist

    Input Example

    POST / HTTP/1.1
    Host: antiddos.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeListBlackWhiteIpList
    <Common request parameters>
    
    {
        "FilterInstanceId": "bgpip-0000011x",
        "FilterIp": "1.1.1.1",
        "Limit": "25",
        "Offset": "0"
    }
    

    Output Example

    {
        "Response": {
            "IpList": [
                {
                    "InstanceDetailList": [
                        {
                            "InstanceId": "bgpip-0000011x",
                            "EipList": [
                                "1.2.2.19"
                            ]
                        }
                    ],
                    "Ip": "1.1.4.1",
                    "Type": "white",
                    "Mask": 1,
                    "ModifyTime": "2022-11-29 18:34:13"
                }
            ],
            "Total": 1,
            "RequestId": "j5RV4a5576e8cf46f24e3bae026ebb391a"
        }
    }
    

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持