점검 항목 조회

Prev Next

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

Cloud Advisor 서비스에서 제공하는 점검 항목을 조회합니다.

요청

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

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

요청 헤더

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' \
--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 - 오류 메시지

점검 항목

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

필드 타입 필수 여부 설명
categoryCode String - 점검 카테고리 코드
itemCode String - 점검 항목 코드
itemName String - 점검 항목 이름
itemDescription String - 점검 항목 요약 정보
itemDescriptionDetail String - 점검 항목 상세 정보
recommendation String - 점검 항목 권장 조치
checkLogicDescription String - 점검 결과 알림 등급 설명
  • GREEN | YELLOW | RED
    • GREEN: 권장 설정을 준수하고 있는 상태(정상)
    • YELLOW: 조치가 필요한 상태(경고)
    • RED: 빠른 조치가 필요한 상태(위험)
checkResultType String - 인스턴스별 상세 점검 결과 제공 유형
  • TABLE | SAMPLE
    • TABLE: 제공
    • SAMPLE: 미제공(점검 결과 요약만 제공)
tableHeaderInfo Array - 인스턴스별 상세 점검 결과 필드
  • tableHeaderInfo | []
    • tableHeaderInfo: checkResultType이 TABLE인 경우
    • []: checkResultType이 SAMPLE인 경우

tableHeaderInfo

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

필드 타입 필수 여부 설명
key String - 점검 결과 테이블 열의 고유 키
label String - 점검 항목 테이블 열의 이름
type String - 점검 결과 테이블 열의 결과 데이터 타입
  • Status | String | Timestamp | Number | Integer | Long | Float

응답 상태 코드

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

응답 예시

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "categoryCode": "SECURITY",
            "itemCode": "SUB_ACCOUNT_ACCESSKEY",
            "itemName": "Sub Account 액세스키 관리",
            "itemDescription": "서브 계정에 추가된 Access Key의 수명을 점검합니다.",
            "itemDescriptionDetail": "서브 계정의 Access Key 사용일을 점검합니다. 보안 수준을 높이려면 주기적으로 Access Key를 교체하는 것이 좋습니다.",
            "recommendation": "서브 계정이 사용하는 Access Key 사용일이 90일이 지나지않도록 주기적으로 교체합니다.",
            "checkLogicDescription": "{{RED}}: 서브 계정이 사용하고 있는 Access Key 중 사용일이 730일을 초과한 Key가 존재합니다.<br>\n{{YELLOW}}: 서브 계정이 사용하고 있는 Access Key 중 사용일이 90일을 초과한 Key가 존재합니다.<br>\n{{GREEN}}: 서브 계정이 사용하고 있는 모든 Access Key의 사용일이 90일 이내입니다.<br>\n* 사용중인 Access Key에 한해서만 점검이 진행됩니다.",
            "checkResultType": "TABLE",
            "tableHeaderInfo": [
                {
                    "key": "status",
                    "label": "상태",
                    "type": "Status"
                },
                {
                    "key": "loginId",
                    "label": "로그인 아이디",
                    "type": "String"
                },
                {
                    "key": "subAccountName",
                    "label": "서브 계정 이름",
                    "type": "String"
                },
                {
                    "key": "accessKey",
                    "label": "AccessKey",
                    "type": "String"
                },
                {
                    "key": "accessKeyUseDays",
                    "label": "AccessKey 사용 일",
                    "type": "Integer"
                },
                {
                    "key": "accessKeyCreateDate",
                    "label": "AccessKey 생성일",
                    "type": "Timestamp"
                }
            ]
        },
        ...
}