Documentation|Tencent Cloud

Recent Pages

DescribeBlockIPList

Last updated: 2020-07-31 09:56:58

1. API Description

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

This API is used to query the list of blocked IPs (blocklist) of a CLB instance. (This API is in beta test. To use it, please submit a ticket.)

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

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: DescribeBlockIPList.
Version	Yes	String	Common parameter. The value used for this API: 2018-03-17.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId	Yes	String	CLB instance ID.
Offset	No	Integer	Data offset. Default value: 0.
Limit	No	Integer	Maximum number of IPs to be returned. Default value: 100,000.

3. Output Parameters

Parameter Name	Type	Description
BlockedIPCount	Integer	Number of returned IPs
ClientIPField	String	Field for getting real client IP
BlockedIPList	Array of BlockedIP	List of IPs added to blocklist 12360
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of blocked IPs (blacklist) of a CLB instance

Input Example

https://clb.tencentcloudapi.com/?Action=DescribeBlockIPList
&LoadBalancerId=lb-6efswuxa
&<Common request parameters>

Output Example

{
  "Response": {
    "BlockedIPCount": 1,
    "BlockedIPList": [
      {
        "IP": "192.1.2.3",
        "CreateTime": "2019-01-10 10:55:40",
        "ExpireTime": "2019-01-10 11:12:19"
      }
    ],
    "ClientIPField": "test",
    "RequestId": "83329908-a282-4f9f-82ab-033a3025baff"
  }
}

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.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.FormatError	Wrong parameter format.
InvalidParameterValue	Wrong parameter value.
InvalidParameterValue.Length	Wrong parameter length.
UnauthorizedOperation	Unauthorized operation.