GetPlannedMaintenanceList

Overview

Get the planned maintenance list.

Request

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/planned-maintenances
Method: GET

Request headers

The request headers specified in common settings are required.

Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Request query parameters

The GetPlannedMaintenanceList API supports two types of get methods as follows. You must select one of two ways to query.

• Time range query method: Query using the parameters from, to, and timeType.
• Resource ID query method: Query using the parameters productKey and resourceId.

Examples

Request example

The following is an example of getting a planned maintenance list.

GET /cw_fea/real/cw/api/planned-maintenances?pageNum=1&pageSize=1
Host: cw.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Response example

If the query is completed without errors, the planned maintenance's list is returned with HTTP code 200.

{
  "data": [
    {
      "desc": "",
      "dimensions": {
        "{cw_key}": [
          {
            "instanceNo": "{instanceNo}",
            "mnt_nm": "/",
            "type": "fs"
          }
        ]
      },
      "endTime": 1721133000000,
      "id": "{pm_id}",
      "startTime": 1721129400000,
      "title": "{pm_title}"
    }
  ],
  "pageNumCurrent": 1,
  "pageNumTotal": 1,
  "pageSize": 1,
  "total": 1
}