Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

점검 카테고리 조회

Prev Next

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

Cloud Advisor 서비스에서 제공하는 점검 카테고리를 조회합니다.

요청

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

메서드 URI
GET /api/v1/categories

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories' \
--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 - 점검 카테고리 목록: contents

contents

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

필드 타입 필수 여부 설명
categoryCode String - 점검 카테고리 코드
categoryName String - 점검 카테고리 코드 이름

응답 상태 코드

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

응답 예시

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "categoryCode": "SECURITY",
            "categoryName": "보안"
        },
        {
            "categoryCode": "COST",
            "categoryName": "비용&고가용성"
        }
    ]
}