Last updated: 2020-09-10 17:36:58

1. API Description

Domain name for API request:

This API is used to get the IP unblocking records.

A maximum of 10 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 parameter. The value used for this API: DescribeIpUnBlockList.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
BeginTime Yes Timestamp Start time
EndTime Yes Timestamp End time
Ip No String IP (if this field is not empty, IP filtering will be performed)
Paging No Paging Pagination parameter (paginated query will be performed if this field is not empty). This field will be disused in the future. Please use the Limit and Offset fields instead;
Limit No Integer Number of entries per page. A value of 0 means no pagination
Offset No Integer Page start offset, whose value is (page number - 1) * number of entries per page

3. Output Parameters

Parameter Name Type Description
BeginTime String Start time
EndTime String End time
List Array of IpUnBlockData IP unblocking record
Total Integer Total number of records
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining IP address unblocking records

Input Example
&<Common Request Parameters>

Output Example

  "Response": {
    "BeginTime": "2018-09-01 11:59:46",
    "EndTime": "2018-09-10 11:59:46",
    "List": [
        "Ip": "",
        "BlockTime": "2018-09-07 17:12:10",
        "UnBlockTime": "2018-09-07 17:36:41",
        "ActionType": "user"
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Total": 1

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.


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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback