점검 카테고리 점검 결과 요약 조회

Prev Next

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

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

요청

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

메서드 URI
GET /api/v1/categories/{categoryCode}/checkitems/result-summary

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/result-summary' \
--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 - 오류 메시지

점검 항목

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

필드 타입 필수 여부 설명
itemCode String - 점검 항목 코드
status String - 점검 결과 알림 등급
  • GREEN | YELLOW | RED
    • GREEN: 권장 설정을 준수하고 있는 상태(정상)
    • YELLOW: 조치가 필요한 상태(경고)
    • RED: 빠른 조치가 필요한 상태(위험)
summary String - 점검 결과 요약
lastCheckTime String - 마지막 점검 일시
  • Unix Timestamp 형식

응답 상태 코드

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

응답 예시

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "itemCode": "CLOVA_OCR_UNUSED_RESOURCES",
            "status": "GREEN",
            "summary": "<span>[KR] 전체 CLOVA OCR 도메인 중 0개가 지난 7일간 인식 요청이 없습니다.<br/></span>",
            "lastCheckTime": 0
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "status": "GREEN",
            "summary": "전체 CLOVA Dubbing 도메인 중 0개가 지난 7일간 사용량이 없거나, 프로젝트가 존재하지 않습니다.\n\n",
            "lastCheckTime": 0
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "status": "GREEN",
            "summary": "전체 Server 0개 중 0개가 Idle 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "status": "GREEN",
            "summary": "전체 Load Balancer 0개 중 0개가 Idle 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "status": "GREEN",
            "summary": "전체 Server 0개 중 0개가 High Utilization 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "status": "GREEN",
            "summary": "전체 DB Server 0개 중 0개가 High Utilization 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "status": "GREEN",
            "summary": "전체 Redis Server 0개 중 0개가 High Utilization 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "status": "GREEN",
            "summary": "전체 DB Server 0개 중 0개가 High Utilization 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "status": "GREEN",
            "summary": "전체 DB Server 0개 중 0개가 High Utilization 상태입니다.",
            "lastCheckTime": 0
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "status": "GREEN",
            "summary": "<span>[KR] 전체 Bucket 0개 중 0개 Bucket에서 총 0개, 0의 불완전한 Multi-Part Object를 발견했습니다.<br/></span>",
            "lastCheckTime": 0
        }
    ]
}