Classic/VPC 환경에서 이용 가능합니다.
계정에 적용된 리소스별 이용 한도를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /open-api/v1/policy/allotment/{memberNo}/{regionNo} |
요청 헤더
Organization API에서 공통으로 사용하는 헤더에 대한 정보는 Organization 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
memberNo |
Integer | Required | 계정 회원 번호
|
regionNo |
String | Required | 리전 번호
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/allotment/260****/1' \
--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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
resourceTypeCode |
String | - | 리소스 코드 |
resourceName |
String | - | 리소스 이름 |
customResourceName |
String | - | 리소스 이름
|
lowerResourceName |
String | - | 하위 리소스 이름 |
resourceCategoryTypeCode |
String | - | 리소스 카테고리 코드 |
resourceQuotaDetailConfigYn |
String | - | 리소스 상세 설정 필요 여부
|
sortOrder |
Integer | - | 목록 정렬 순서 |
useYn |
String | - | 리소스 사용 여부
|
exposureYn |
String | - | 리소스 노출 여부
|
restrictionUnitCode |
String | - | 이용 한도 단위 코드 |
restrictionUnitDescription |
String | - | 이용 한도 단위 코드 설명 |
resourceQuotaList |
Array | - | 리소스 이용 한도 |
resourceQuotaDetailList |
Array | - | 리소스 유형 이용 한도
|
resourceQuotaList
resourceQuotaList
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
policyNo |
String | - | 정책 번호 |
resourceQuotaSequence |
String | - | 이용 한도 일련 번호 |
regionNo |
String | - | 리전 번호 |
resourceTypeCode |
String | - | 리소스 코드 |
restrictionCount |
Integer | - | 이용 한도 |
resourceQuotaDetailList
resourceQuotaDetailList
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
policyNo |
String | - | 정책 번호 |
resourceQuotaSequence |
String | - | 이용 한도 일련 번호 |
regionNo |
String | - | 리전 번호 |
resourceTypeCode |
String | - | 리소스 코드 |
productTypeCodeName |
String | - | 리소스 유형 |
productTypeDetailCodeName |
String | - | 리소스 상세 유형 |
generationCode |
String | - | 세대 구분 코드
|
restrictionCount |
Integer | - | 이용 한도 |
응답 상태 코드
Organization API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Organization 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
[
{
"resourceTypeCode": "SVR",
"resourceName": "Server",
"customResourceName": "Server",
"lowerResourceName": null,
"resourceCategoryTypeCode": "COMPUTE",
"resourceQuotaDetailConfigYn": "Y",
"sortOrder": 1,
"useYn": "Y",
"exposureYn": "Y",
"restrictionUnitCode": "COUNT",
"restrictionUnitDescription": "Server 생성 수",
"resourceQuotaList": [
{
"policyNo": "1",
"resourceQuotaSequence": "18",
"regionNo": "1",
"resourceTypeCode": "SVR",
"restrictionCount": 50
}
],
"resourceQuotaDetailList": [
{
"policyNo": "1",
"resourceQuotaSequence": "18",
"regionNo": "1",
"resourceTypeCode": "SVR",
"productTypeCodeName": "BareMetal",
"productTypeDetailCodeName": "BareMetal",
"generationCode": "G1",
"restrictionCount": 5
},
{
"policyNo": "1",
"resourceQuotaSequence": "18",
"regionNo": "1",
"resourceTypeCode": "SVR",
"productTypeCodeName": "CPU",
"productTypeDetailCodeName": "CPU",
"generationCode": "G1",
"restrictionCount": 5
}
...
]
},
{
"resourceTypeCode": "PBLIP",
"resourceName": "Public IP",
"customResourceName": "Public IP",
"lowerResourceName": null,
"resourceCategoryTypeCode": "COMPUTE",
"resourceQuotaDetailConfigYn": "N",
"sortOrder": 12,
"useYn": "Y",
"exposureYn": "Y",
"restrictionUnitCode": "REL_COUNT",
"restrictionUnitDescription": "Public IP 생성 수",
"resourceQuotaList": [
{
"policyNo": null,
"resourceQuotaSequence": null,
"regionNo": "1",
"resourceTypeCode": "PBLIP",
"restrictionCount": 100
}
],
"resourceQuotaDetailList": []
},
...
]