리소스 유형 목록 조회

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

Quota Policy(이용 한도 정책)를 적용할 수 있는 리소스 유형(하위 리소스) 목록을 조회합니다.

참고

리소스 유형 목록 조회 API는 리소스 상세 설정(이용 한도 설정)이 필요한 경우에만 정상적으로 응답을 반환합니다. 리소스 목록 조회 응답 결과에서 resourceQuotaDetailConfigYn 값이 Y인 리소스에 한해 사용해 주십시오.

요청

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

메서드	URI
GET	/open-api/v1/policy/detail/{regionNo}/{resourceTypeCode}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`regionNo`	Integer	Required	리전 번호 리전 목록 조회 참조
`resourceTypeCode`	String	Required	리소스 코드 리소스 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/detail/1/VSVR' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`productTypeCode`	String	-	리소스 유형 코드
`productTypeName`	String	-	리소스 유형 이름
`resourceQuotaDetailConfigYn`	String	-	리소스 상세 설정 필요 여부 `Y` \| `N` `Y`: 필요 `N`: 필요 없음
`productTypeDetailList`	Array	-	리소스 상세 유형 정보

`productTypeDetailList`

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

필드	타입	필수 여부	설명
`productTypeDetailCode`	String	-	리소스 상세 유형 코드
`productTypeDetailName`	String	-	리소스 상세 유형 이름
`generationCodeList`	Array	-	세대 구분 정보 서버 조회 시 표시

`generationCodeList`

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

필드	타입	필수 여부	설명
`generationCode`	String	-	세대 구분 코드 리소스 상세 유형 기준
`maxProductRestrictCount`	Integer	-	세대별 최대한도

응답 상태 코드

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

응답 예시

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

[
    {
        "productTypeCode": "STAND",
        "productTypeName": "Standard",
        "resourceQuotaDetailConfigYn": "Y",
        "productTypeDetailList": [
            {
                "productTypeDetailCode": "STAND",
                "productTypeDetailName": "Standard",
                "generationCodeList": [
                    {
                        "generationCode": "G2",
                        "maxProductRestrictCount": 50
                    },
                    {
                        "generationCode": "G3",
                        "maxProductRestrictCount": 50
                    }
                ]
            }
        ]
    },
    {
        "productTypeCode": "HICPU",
        "productTypeName": "High CPU",
        "resourceQuotaDetailConfigYn": "Y",
        "productTypeDetailList": [
            {
                "productTypeDetailCode": "HICPU",
                "productTypeDetailName": "High CPU",
                "generationCodeList": [
                    {
                        "generationCode": "G2",
                        "maxProductRestrictCount": 50
                    },
                    {
                        "generationCode": "G3",
                        "maxProductRestrictCount": 50
                    }
                ]
            }
        ]
    },
  ...
]