점검 결과 상세 포함 설정

Prev Next

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

점검 항목 점검 결과 상세 조회 시 포함할 인스턴스를 설정합니다.

참고

인스턴스에 점검 결과 제외 설정을 하지 않은 경우, 별도의 점검 결과 상세 포함 설정을 하지 않아도 점검 결과에 기본적으로 포함하여 표시됩니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
root Array Required 조회 가능한 인스턴스의 instanceKey
참고

instanceKey 입력 시 다음 내용을 참고해 주십시오.

  • 영어 대소문자를 구분하여 입력해야 합니다.
  • 유효하지 않은 값이 있는 경우, 해당 값을 제외하고 유효한 값에 대해서만 설정합니다.

요청 예시

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

curl --location --request POST 'https://cloud-advisor.apigw.ntruss.com/api/v1 /categories/{categoryCode}/checkitems/{itemCode}/result-detail/include' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '[
           "ncp_iam_BPA*************IMje",
           "ncp_iam_BPA*************4NH"
 ]'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
result String - API 처리 결과
  • SUCCESS | FAIL
    • SUCCESS: 성공
    • FAIL: 실패
contents String - 설정 결과

응답 상태 코드

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

응답 예시

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

{
  "result": "SUCCESS",
  "contents": "done"
}