GetPlannedMaintenanceList

概要

Planned Maintenanceリストを照会します。

リクエスト

API URL

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

リクエストヘッダ

共通の設定に明示されたリクエストヘッダが必要です。

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}

リクエストクエリパラメータ

GetPlannedMaintenanceList APIは、以下の2つの照会方法をサポートします。2つ方法のうち、必ずいずれか1つ選択して照会します。

• 時間範囲照会方法: from、to、timeTypeパラメータを使用して照会します。
• リソース ID照会方法: productKey、resourceIdパラメータを使用します。

例

リクエスト例

次は、Planned Maintenanceリストを照会するサンプルコードです。

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}

レスポンス例

エラーなしで照会が完了した場合、HTTPコード200と共に Planned Maintenanceのリストが返されます。

{
  "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
}