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.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
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. |
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. |
https://clb.tencentcloudapi.com/?Action=DescribeBlockIPList
&LoadBalancerId=lb-6efswuxa
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter value. |
InvalidParameterValue.Length | Wrong parameter length. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?