Available in Classic and VPC
Get the list of resource types (child resources) to which the quota policy can be applied.
The Get resource type list API returns a response only when resource details (usage limit settings) are required. Use it only for resources with a resourceQuotaDetailConfigYn
value of Y
in the response result of Get resource list.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /open-api/v1/policy/detail/{regionNo}/{resourceTypeCode} |
Request headers
For information about the headers common to all Organization APIs, see Organization request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
regionNo |
Integer | Required | Region number
|
resourceTypeCode |
String | Required | Resource code |
Request example
The request example is as follows:
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'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
productTypeCode |
String | - | Resource type code |
productTypeName |
String | - | Resource type name |
resourceQuotaDetailConfigYn |
String | - | Whether resource detailed settings are required
|
productTypeDetailList |
Array | - | Resource detailed type information |
productTypeDetailList
The following describes productTypeDetailList
.
Field | Type | Required | Description |
---|---|---|---|
productTypeDetailCode |
String | - | Resource detailed type code |
productTypeDetailName |
String | - | Resource detailed type name |
generationCodeList |
Array | - | Generation classification information
|
generationCodeList
The following describes generationCodeList
.
Field | Type | Required | Description |
---|---|---|---|
generationCode |
String | - | Generation classification code
|
maxProductRestrictCount |
Integer | - | Maximum limit by generation |
Response status codes
For response status codes common to all Organization APIs, see Organization response status codes.
Response example
The response example is as follows:
[
{
"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
}
]
}
]
},
...
]