VPC 환경에서 이용 가능합니다.
점검 항목에 대한 점검 결과를 요약하여 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-summary |
요청 헤더
Cloud Advisor API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Advisor 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
categoryCode |
String | Required | 점검 카테고리 코드
|
itemCode |
String | Required | 점검 항목 코드
|
요청 예시
요청 예시는 다음과 같습니다.
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 처리 결과
|
contents |
Object | - | 점검 항목 |
contents.itemCode |
String | - | 점검 항목 코드 |
contents.status |
String | - | 점검 결과 알림 등급
|
contents.summary |
String | - | 점검 결과 요약 |
contents.lastCheckTime |
String | - | 마지막 점검 일시
|
error |
Object | - | 오류 코드 및 메시지
|
error.errorCode |
String | - | 오류 코드 |
error.message |
String | - | 오류 메시지 |
응답 상태 코드
Cloud Advisor API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Advisor 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"result": "SUCCESS",
"contents": {
"itemCode": "SUB_ACCOUNT_USE",
"status": "GREEN",
"summary": "해당 메인 계정 하위에 서브 계정 1개 이상 생성되어 있습니다.",
"lastCheckTime": 1743353842784
}
}