DescribeIpBlockEvents

1. API Description

This API is used to query information on IP blocking event.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
startTime	Yes	Timestamp	Start time. Format: yyyy-MM-ddTHH:mm:ssZ.
endTime	Yes	Timestamp	End time. Format: yyyy-MM-ddTHH:mm:ssZ.
ip	No	String	Blocked IP address.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataList	Array of IpBlockEventInfo	Information on IP blocking event.

4. Code Example

Example

Queries information on IP blocking event.

POST /api/v2/alarm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeIpBlockEvents
<Common Request Params>

Request:
{
    "startTime":"2023-07-26T16:00:00Z",
    "endTime":"2023-08-03T15:59:59Z",
    "ip":"10.1.1.1"
}

Response:
{
  "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
  "dataList": [
        {
            "ip": "10.1.1.1",
            "region": "area-shanghai-1",
            "resourceGroup": "resourceGroup-1",
            "blockTime": "2023-07-28T16:00:00Z",
            "unblockTime": "2023-07-29T16:00:00Z",
            "divertMode": "automatically"
        }
 ]
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​​