DescribeMaintenanceAlerts

1. API Description

This API is used to query maintenance alert notifications.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
product	Yes	String	Products supported. Currently Bare Metal (BMC) and Cloud Networking (SDN) are available.

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 MaintenanceAlerts	Information on maintenance alert notifications.

4. Code Example

Example

Queries maintenance notifications.

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

Request:
{
    "product":"SDN"
}

Response:
{
  "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
  "dataList": [
        {
            "instanceId": "node-1afmdaxzad23",
            "location": "area-shanghai-1",
            "impact": "this is impact infomation",
            "startTime": "2023-07-28T16:00:00Z",
            "endTime": "2023-07-29T16:00:00Z",
            "status": "in progress"
        }
 ]
}

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.​​