점검 항목 점검 결과 상세 조회

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

점검 항목에 대한 인스턴스별 상세 점검 결과를 조회합니다. 점검 항목의 인스턴스별 상세 점검 결과 제공 여부는 점검 항목 조회에서 확인할 수 있습니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`categoryCode`	String	Required	점검 카테고리 코드 `SECURITY` \| `COST` `SECURITY`: 보안 카테고리 `COST`: 비용&고가용성 카테고리
`itemCode`	String	Required	점검 항목 코드 점검 항목 코드 참조

참고

점검 카테고리(categoryCode)에 속하지 않는 점검 항목(itemCode)으로 요청 시 404 오류가 발생합니다.

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`display`	String	Optional	조회 대상 인스턴스 `all` \| `included` (기본값)\| `excluded` `all`: 전체 인스턴스 `included`: 포함 설정 인스턴스 `excluded`: 제외 설정 인스턴스
`page`	Integer	Required	페이지 번호 1~N
`size`	Integer	Required	페이지당 항목 수 1~N

참고

포함 인스턴스 또는 제외 인스턴스는 다음 API를 통해 설정할 수 있습니다.

포함 인스턴스 설정: 점검 결과 상세 포함 설정
제외 인스턴스 설정: 점검 결과 상세 제외 설정

요청 예시

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-detail?display=all&page=1&size=5' \
--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`	Object	-	점검 항목
`contents.itemCode`	String	-	점검 항목 코드
`meta`	Object	-	페이지 처리를 위한 메타 데이터
`meta.totalPage`	Integer	-	전체 페이지 수
`meta.currentPage`	Integer	-	현재 페이지 번호
`meta.size`	Integer	-	페이지당 항목 수
`data`	Array	-	점검 항목의 인스턴스별 상세 점검 결과: `ResultTableRow`

`ResultTableRow`

ResultTableRow에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`memberNo`	Integer	-	계정 회원 번호
`instanceNo`	Integer	-	인스턴스 번호
`itemSid`	Integer	-	점검 항목 아이디 0~2147483647
`instanceKey`	Integer	-	인스턴스 고유 키
`status`	String	-	점검 결과 알림 등급 `GREEN` \| `YELLOW` \| `RED` `GREEN`: 권장 설정을 준수하고 있는 상태(정상) `YELLOW`: 조치가 필요한 상태(경고) `RED`: 빠른 조치가 필요한 상태(위험)

참고

위 표에서는 인스턴스별 공통으로 제공하는 필드에 대해서 안내합니다. 각 인스턴스별로 제공되는 자세한 필드 정보는 점검 결과 상세 조회 응답 결과의 tableHeaderInfo에서 확인해 주십시오.

응답 상태 코드

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

응답 예시

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

{
  "result": "SUCCESS",
  "contents": {
    "itemCode": "SUB_ACCOUNT_USE",
    "meta": {
      "totalPage": 1,
      "currentPage": 1,
      "size": 5
    },
    "data": [
      {
        "memberNo": 2*****2,
        "instanceNo": 0,
        "itemSid": 2,
        "instanceKey": "2*****2",
        "status": "GREEN"
      }
    ]
  }
}