GetPlannedMaintenanceList

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

전체 유지 보수 일정 목록을 조회합니다. 조회 방식은 두 가지를 지원하며, 선택하여 호출해야 합니다.

  • 시간 범위로 조회: 요청 쿼리 파라미터 from, to, timeType 사용
  • 리소스 아이디로 조회: 요청 쿼리 파라미터 resourceId, productKey 사용

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /cw_fea/real/cw/api/planned-maintenances

요청 헤더

Cloud Insight API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Insight 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
from Integer Conditional 조회 시작 일시
  • Unix timestamp 형식
  • 시간 범위로 조회 시 사용
to Integer Conditional 조회 종료 일시
  • Unix timestamp 형식
  • 시간 범위로 조회 시 사용
timeType String Conditional 조회 기준
  • startTime | endTime
    • startTime: 시작 시간
    • endTime: 종료 시간
  • 시간 범위로 조회 시 사용
resourceId String Conditional 리소스 아이디
productKey String Conditional 상품 키(cw_key)
pageNum Integer Required 페이지 번호
  • 1~N
pageSize Integer Required 페이지 출력 수
  • 1~N

요청 예시

요청 예시는 다음과 같습니다.

시간 범위로 조회

시간 범위로 조회하는 요청 예시는 다음과 같습니다.

curl --location --request GET 'https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/planned-maintenances?pageNum=1&pageSize=5&from=**********&to=**********&timeType=endTime' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

리소스 아이디로 조회

리소스 아이디로 조회하는 요청 예시는 다음과 같습니다.

curl --location --request GET 'https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/planned-maintenances?pageNum=1&pageSize=5&productKey=**********&resourceId=**********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

유지 보수 일정 정보 관련 필드에 대한 설명은 PMCreateUpdateDto를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Insight API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "data": [
        {
            "desc": "Planned Maintenance 예시01",
            "dimensions": {
                "**********": [
                    {
                        "instanceNo": "**********",
                        "mnt_nm": "/",
                        "type": "fs"
                    }
                ]
            },
            "endTime": 1721133000000,
            "id": "**********",
            "startTime": 1721129400000,
            "title": "test-pm-delete"
        },
        {
            "desc": "Planned Maintenance 예시02",
            "dimensions": {
                "**********": [
                    {
                        "instanceNo": "**********",
                        "mnt_nm": "/",
                        "type": "fs"
                    }
                ]
            },
            "endTime": 1721133356000,
            "id": "**********",
            "startTime": 1721129412000,
            "title": "test-pm"
        }
    ],
    "pageNumCurrent": 1,
    "pageNumTotal": 1,
    "pageSize": 5,
    "total": 2
}