Cloud Advisor 개요

개요

Cloud Advisor는 사용자의 리소스를 점검하여 리소스가 안정적인 상태에서 운영될 수 있도록 도와주는 management 서비스입니다.

공통 설정

API URL

https://cloud-advisor.apigw.ntruss.com/api/v1/

요청 헤더

• Cloud Advisor API 를 요청하기 위해서는 NAVER Cloud Platform 계정 및 서브 계정의 인증키 생성 및 인증 값이 필요합니다.
• Cloud Advisor API 요청 시 헤더를 통해 전달한 NCP 계정 및 서브 계정의 점검 항목들에 대한 결과를 응답합니다.
• 인증키 생성과 요청 헤더 생성 관련 내용은 Ncloud API Guide > API 호출 가이드를 참고해 주십시오.

응답 포멧

응답 포맷 예

• 성공 예시

{
  "result": "SUCCESS",
  "contents": [
    {
      "categoryCode": "SECURITY",
      "categoryName": "보안"
    },
    {
      "categoryCode": "COST",
      "categoryName": "비용&고가용성"
    }
  ]
}

• 실패 예시

{
  "result": "FAIL"
  "error": {
    "errorCode": "API_CHECKITEM_NOT_FOUND",
    "message": "점검항목이 존재하지 않습니다.(API_CHECKITEM_NOT_FOUND); Field 오류"
  }
}

응답 코드

• 응답 코드에는 Cloud Advisor 서비스만의 응답 코드와 서비스 공통 오류 코드가 있습니다. 서비스 공통 오류 코드는 Ncloud API Guide > 3. 호출 > 실패 가이드를 참고해 주십시오.
• Cloud Advisor 서비스만의 응답 코드별 메시지와 설명은 다음과 같습니다.

제공 카테고리 및 점검 항목

현재 Cloud Advisor는 보안 및 비용&고가용성 카테고리에 한하여 점검 항목을 제공합니다.
추후 더 많은 카테고리와 점검 항목을 지속적으로 추가할 예정입니다.
Cloud Advisor API path 에 포함되는 categoryCode 및 itemCode 는 아래와 같습니다.

{categoryCode}

{itemCode}