점검 카테고리 상태 조회

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

점검 카테고리의 전체 점검 항목에 대한 점검 요청 가능 여부를 조회합니다.

요청

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

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

요청 헤더

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/status' \
--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	-	점검 항목 코드
`timeToRefresh`	Long	-	다음 점검 가능 일시 Unix Timestamp 형식
`lastRequestTime`	Long	-	마지막 점검 일시 Unix Timestamp 형식
`status`	String	-	점검 상태 `NONE` \| `ENQUEUED` \| `PROCESSING` \| `DONE` \| `FAIL` `NONE`: 점검 요청 가능 `ENQUEUED`: 점검 대기 중 `PROCESSING`: 점검 진행 중 `DONE`: 점검 요청 완료. 다음 요청까지 대기 필요 `FAIL`: 점검 요청 실패
`refreshable`	String	-	점검 요청 가능 여부 `true` \| `false` `true`: 가능 `false`: 불가능

응답 상태 코드

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

응답 예시

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "itemCode": "CLOVA_OCR_UNUSED_RESOURCES",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        }
    ]
}