Cloud Advisor 개요

Prev Next

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

Cloud Advisor는 네이버 클라우드 플랫폼에서 사용 중인 리소스를 보안, 비용 및 고가용성 측면에서 자동으로 점검할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Cloud Advisor 서비스에서는 점검 관련 기능에 대한 API를 RESTful 형태로 제공합니다.

Cloud Advisor 공통 설정

Cloud Advisor API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

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

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
x-ncp-lang Optional 응답 데이터의 다국어 처리
  • ko-KR (기본값) | en-US | ja-JP | zh-CN
    • ko-kR: 한국어
    • en-US: 영어
    • ja-JP: 일본어
    • zh-CN: 중국어(간체)
참고

API 호출 시 다음 내용을 참고해 주십시오.

  • 점검 카테고리(categoryCode)에 속하지 않는 점검 항목(itemCode)으로 요청하면 404 오류가 발생합니다.
  • 서브 계정에서 Cloud Advisor API를 호출하는 경우, 서브 계정에 권한이 있는 정보에 대해서만 응답 결과로 반환합니다.

응답

공통 응답 형식을 설명합니다.

응답 예시

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

성공
호출이 성공한 경우의 응답 예시는 다음과 같습니다.

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

실패
호출이 실패한 경우의 응답 예시는 다음과 같습니다.

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

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
200 - OK 요청 처리 성공
400 - MISSING_REQUIRED_PARAM_ERROR 필수 파라미터 누락
400 - INVALID_PARAM_VALUE_ERROR 유효하지 않은 파라미터
401 - NO_AUTHENTICATION_INFORMATION 요청 인증 실패
403 - SUBACCOUNT_PERMISSION_DENIED 서브 계정에 해당 기능에 대한 권한 없음
404 - CATEGORY_NOT_FOUND 존재하지 않는 점검 카테고리
404 - CHECKITEM_NOT_FOUND 존재하지 않는 점검 항목
500 - API_UNKNOWN_SERVER_ERROR 알 수 없는 오류
참고

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

Cloud Advisor 점검 항목

Cloud Advisor 서비스에서 점검 카테고리별로 제공하는 점검 항목에 대한 설명은 다음과 같습니다.

점검 카테고리

점검 카테고리에 대한 설명은 다음과 같습니다.

점검 카테고리 코드 설명
SECURITY 보안 카테고리
COST 비용 & 고가용성 카테고리

점검 항목

점검 항목에 대한 설명은 다음과 같습니다.

점검 카테고리 코드 점검 항목 코드 점검 항목 설명
SECURITY SUB_ACCOUNT_ACCESSKEY Sub Account 액세스키 관리 서브 계정의 Access Key 수명 점검
SECURITY SUB_ACCOUNT_USE Sub Account 사용 서브 계정의 사용 여부 점검
SECURITY SUB_ACCOUNT_PASSWORD Sub Account 비밀번호 관리 서브 계정의 비밀번호 사용일 점검
SECURITY SUB_ACCOUNT_SECONDARY Sub Account 2차인증 설정여부 서브 계정의 2차 인증 설정 여부 점검
SECURITY MAIN_ACCOUNT_ACCESSKEY Main Account 액세스키 관리 메인 계정의 Access Key 사용일 점검
SECURITY MAIN_ACCOUNT_PASSWORD Main Sccount 비밀번호 관리 메인 계정의 비밀번호 사용일 점검
SECURITY MAIN_ACCOUNT_SECONDARY Main Account 2차인증 설정여부 메인 계정의 2차 인증 설정 여부 점검
SECURITY LOAD_BALANCER_LISTENER Load Balancer 리스너 보안 관리 VPC 환경에서 생성한 애플리케이션 로드 밸런서, 네트워크 프록시 로드 밸런서에 권장하는 암호화 통신을 하는 리스너 설정 여부 점검
SECURITY DNS_SPF Global DNS 레코드 SPF MX 점검 Global DNS 서비스에 MX 레코드가 존재하는 경우, MX 레코드에 대응하는 SPF 또는 TXT 레코드 존재 여부 점검
SECURITY DNS_TTL Global DNS 레코드 TTL 점검 TTL이 권장값인 300초보다 높은 Global DNS 레코드 유무 점검
SECURITY DNS_AUTHORITY Global DNS Authority NS점검 도메인 등록자 또는 DNS의 올바른 Global DNS 네임 서버 사용 여부 점검
SECURITY OBJECT_STORAGE_BUCKET Object Storage 버킷 권한 전체 버킷의 ACL을 확인하여 외부 공개 여부 점검
SECURITY CLOUD_DB_MYSQL_PORT Cloud DB MYSQL 기본 PORT 점검 Cloud DB for MySQL 서비스에서 생성한 DB 서버의 기본 포트(3306) 사용 여부 점검
SECURITY ACG_PORT ACG 포트 관리 특정 포트를 전체 IP 대역에 공개하는(Any Open) ACG 규칙 존재 여부 점검
SECURITY SUB_ACCOUNT_ROLE Sub Account 서비스의 Role 관리 Sub Account 서비스의 Role 사용일 점검
COST CLOVA_OCR_UNUSED_RESOURCES Unused Resource - CLOVA OCR 최근 7일간 사용하지 않은 CLOVA OCR 도메인 유무 점검
COST CLOVA_DUBBING_UNUSED_RESOURCES Unused Resource - CLOVA Dubbing 최근 7일간 사용하지 않은 CLOVA Dubbing 도메인 유무 점검
COST IDLE_RESOURCE_VM Idle Resource - Server(VPC) 사용량이 적어 미사용인 것으로 보이는 Server 유무 점검
COST IDLE_RESOURCE_LB Idle Resource - Load Balancer(VPC) 사용량이 적어 미사용인 것으로 보이는 Load Balancer 유무 점검
COST HIGH_UTILIZATION_VM High Utilization - Server(VPC) CPU 사용률이 높은 상태로 유지되고 있는 Server 유무 점검
COST HIGH_UTILIZATION_MYSQL High Utilization - Cloud DB for MySQL(VPC) CPU 사용률이 높은 상태로 유지되고 있는 Cloud DB for MySQL 서비스의 DB 서버 유무 점검
COST HIGH_UTILIZATION_REDIS High Utilization - Cloud DB for Cache(VPC) CPU 사용률이 높은 상태로 유지되고 있는 Cloud DB for Cache 서비스의 DB 서버 유무 점검
COST HIGH_UTILIZATION_MSSQL High Utilization - Cloud DB for MSSQL(VPC) CPU 사용률이 높은 상태로 유지되고 있는 Cloud DB for MSSQL 서비스의 DB 서버 유무 점검
COST HIGH_UTILIZATION_MONGO High Utilization - Cloud DB for MongoDB(VPC) CPU 사용률이 높은 상태로 유지되고 있는 Cloud DB for MongoDB 서비스의 DB 서버 유무 점검
COST OBJECT_STORAGE_MULTIPART Object Storage 내 불완전한 Multi-Part Object Bucket 내 불완전한 Multi-Part Object 유무 점검>

Cloud Advisor API

Cloud Advisor 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

API 설명
점검 카테고리 조회 Cloud Advisor 서비스에서 제공하는 점검 카테고리 조회
점검 카테고리 상태 조회 점검 카테고리의 전체 점검 항목에 대한 점검 요청 가능 여부 조회
점검 카테고리 점검 요청 점검 카테고리의 전체 점검 항목에 대한 점검 요청
점검 카테고리 점검 결과 등급 조회 점검 카테고리의 전체 점검 항목에 대한 알림 등급별 점검 결과 요약 조회
점검 카테고리 점검 결과 요약 조회 점검 카테고리의 전체 점검 항목에 대한 점검 결과 요약 조회
점검 카테고리 점검 결과 다운로드 점검 카테고리의 전체 점검 항목에 대한 점검 결과 다운로드
점검 항목 조회 Cloud Advisor 서비스에서 제공하는 점검 항목 조회
점검 항목 상태 조회 점검 항목에 대한 점검 요청 가능 여부 조회
점검 항목 점검 요청 점검 항목에 대한 점검 요청
점검 항목 점검 결과 요약 조회 점검 항목에 대한 점검 결과 요약 조회
점검 항목 점검 결과 상세 조회 점검 항목에 대한 인스턴스별 상세 점검 결과 조회
점검 항목 점검 결과 다운로드 점검 항목에 대한 점검 결과 다운로드
점검 결과 상세 포함 설정 점검 항목 점검 결과 상세 조회 시 포함할 인스턴스 설정
점검 결과 상세 제외 설정 점검 항목 점검 결과 상세 조회 시 제외할 인스턴스 설정
점검 결과 다운로드 전체 점검 카테고리의 점검 항목에 대한 점검 결과 다운로드

Cloud Advisor 연관 리소스

Cloud Advisor API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.