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는 아래 두 가지 조회 방식을 지원합니다. 반드시 두 가지 방식 중 하나를 선택하여 조회해야 합니다.

• 시간 범위 조회 방식: 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
}