점검 항목 조회
- 인쇄
- PDF
점검 항목 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
- Cloud Advisor에서 제공하는 점검 항목의 정보를 확인할 수 있습니다.
API
- GET /categories/{categoryCode}/checkitems
요청
Headers
개요에 명시된 공통 요청 헤더가 필요합니다.
Path Variables
파라미터명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
categoryCode | Y | String | 제공 카테고리 및 점검 항목 참고해 주시기 바랍니다. | 카테고리 코드 |
응답
Response Body
{
"result": "SUCCESS",
"contents": [
{
"categoryCode": String,
"itemCode": String,
"itemName": String,
"itemDescription": String,
"itemDescriptionDetail": String,
"recommendation": String,
"checkLogicDescription": String,
"checkResultType": String,
"tableHeaderInfo": [
{
"key" : String,
"label" : String,
"type": String
},
...
]
},
...
]
}
응답 필드명 | 필수여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
categoryCode | Y | String | SECURITY, COST | 카테고리 코드 |
itemCode | Y | String | 점검 항목 코드 | |
itemName | Y | String | 점검 항목명 x-ncp-lang 헤더에 따른 다국어 적용 | |
itemDescription | Y | String | 점검 항목 요약 설명 x-ncp-lang 헤더에 따른 다국어 적용 | |
itemDescriptionDetail | Y | String | 점검 항목 상세 설명 x-ncp-lang 헤더에 따른 다국어 적용 | |
recommendation | Y | String | 점검 항목을 안정적으로 운영하기 위한 방법 안내 x-ncp-lang 헤더에 따른 다국어 적용 | |
checkLogicDescription | Y | String | 점검 항목 점검 결과를 RED / YELLOW / GREEN 으로 나타내는 기준 설명 | |
checkResultType | Y | String | TABLE, SIMPLE | 상세 점검 결과 형태 TABLE : 테이블로 점검 리소스의 인스턴스별 결과 표시. SIMPLE : 점검 리소스의 인스턴스별 결과가 없음. |
tableHeaderInfo | Y | List<TableHeader> | checkResultType : TABLE 인 경우. 인스턴스별 점검 결과 테이블의 헤더 정보 | |
TableHeader.key | N | String | 점검 결과 테이블 컬럼의 unique key | |
TableHeader.label | N | String | 점검 결과 테이블 컬럼명 x-ncp-lang 헤더에 따른 다국어 적용 | |
TableHeader.type | N | String | String, Timestamp, Number, Integer, Long, Float | 점검 결과 테이블 컬럼의 결과 데이터 타입 |
이 문서가 도움이 되었습니까?