점검 카테고리 점검 결과 등급 조회

Prev Next

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

점검 카테고리의 전체 점검 항목에 대한 알림 등급별 점검 결과를 요약하여 조회합니다.

요청

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

메서드 URI
GET /api/v1/categories/{categoryCode}/dashboard

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
categoryCode String Optional 점검 카테고리 코드
  • SECURITY | COST
    • SECURITY: 보안 카테고리
    • COST: 비용&고가용성 카테고리

요청 예시

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/dashboard' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
result String - API 처리 결과
  • SUCCESS | FAIL
    • SUCCESS: 성공
    • FAIL: 실패
contents Array - 점검 카테고리 목록
error Object - 오류 코드 및 메시지
  • result가 FAIL인 경우에 표시
error.errorCode String - 오류 코드
error.message String - 오류 메시지

점검 카테고리

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

필드 타입 필수 여부 설명
categoryCode String - 점검 카테고리 코드
categoryName String - 점검 카테고리 코드 이름
green String - 점검 카테고리에서 점검 결과 알림 등급이 GREEN인 점검 항목 수
  • GREEN: 권장 설정을 준수하고 있는 상태(정상)
yellow String - 점검 카테고리에서 점검 결과 알림 등급이 YELLOW인 점검 항목 수
  • YELLOW: 조치가 필요한 상태(경고)
red String - 점검 카테고리에서 점검 결과 알림 등급이 RED인 점검 항목 수
  • RED: 빠른 조치가 필요한 상태(위험)
참고

blue는 일시적인 내부 오류로 인해 표시되는 알림 등급입니다. 서비스 사용에 영향을 주지 않는 필드이기 때문에 API 응답 결과에 노출되는 경우에는 잠시 후 다시 시도해 주십시오.

응답 상태 코드

Cloud Advisor API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Advisor 응답 상태 코드를 참조해 주십시오.

응답 예시

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "categoryCode": "SECURITY",
            "categoryName": "보안",
            "green": 10,
            "yellow": 4,
            "red": 1,
            "blue": 0
        },
        {
            "categoryCode": "COST",
            "categoryName": "비용&고가용성",
            "green": 10,
            "yellow": 0,
            "red": 0,
            "blue": 0
        }
    ]
}