Queries the quotas of a specified cloud service.
In this example, the operation is called to query the quotas whose instance type is
ecs.g5.2xlarge
. The quotas belong to ECS Quotas by Instance Type. The query result includes the
name, ID, unit, dimensions, and cycle of each quota.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListProductQuotas |
The operation that you want to perform. Set the value to ListProductQuotas. |
NextToken | String | No | 1 |
The token that marks the position from which you want to start the query. An empty value indicates that the query starts from the beginning. |
MaxResults | Integer | No | 30 |
The maximum number of records that you want to return for the query. Valid values: 1 to 200. Default value: 30. |
ProductCode | String | Yes | ecs-spec |
The abbreviation of the cloud service name. Note For more information, see Alibaba Cloud services that support Quota Center.
|
QuotaActionCode | String | No | ecs.g5.2xlarge |
The ID of the quota. |
KeyWord | String | No | ecs-spec |
The keyword that you want to use to search for the quotas. |
SortField | String | No | TIME |
The field based on which you want to sort the returned records. This parameter is available only for quotas that belong to ECS Quotas by Instance Type. Valid values:
|
SortOrder | String | No | Ascending |
The order in which you want to sort the returned records. This parameter is available only for quotas that belong to ECS Quotas by Instance Type. Valid values:
|
QuotaCategory | String | No | FlowControl |
The type of the quota. Valid values:
|
GroupCode | String | No | entconsole_w1j3msbo2g |
The code of the dimension group. |
Dimensions.N.Key | String | No | regionId |
The dimension keys. Note The value range of N varies based on the number of dimensions that are supported by
the related cloud service.
|
Dimensions.N.Value | String | No | cn-hangzhou |
The dimension values. Note The value range of N varies based on the number of dimensions that are supported by
the related cloud service.
|
For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Integer | 4 |
The total number of records that are returned for the query. |
NextToken | String | AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX |
The token that marks the position at which the query ends. An empty value indicates that all data is returned. |
RequestId | String | D0131FD5-5397-44FE-BF5A-4B7165B813CC |
The ID of the request. |
Quotas | Array of Quotas |
The details about the quotas. |
|
QuotaUnit | String | AMOUNT |
The unit of the quota. Note The unit of each quota is unique. For example, the quota whose ID is
q_cbdch3 represents the maximum number of Container Service for Kubernetes (ACK) clusters.
The unit of this quota is clusters. The quota whose ID is q_security-groups represents the maximum number of security groups. The unit of this quota is security
groups.
|
QuotaActionCode | String | ecs.g5.2xlarge |
The ID of the quota. |
TotalUsage | Float | 1 |
The used quota. |
ApplicableRange | Array of Float | 802 |
The range of the quota value, for example, |
QuotaType | String | privilege |
The type of the quota. Default value: normal. Valid values:
|
QuotaDescription | String | ecs.g5.2xlarge |
The description of the quota. |
Period | Object |
The calculation cycle of the quota. |
|
PeriodValue | Integer | 1 |
The value of the calculation cycle of the quota. |
PeriodUnit | String | day |
The unit of the calculation cycle of the quota. Valid values:
|
QuotaArn | String | acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i |
The Alibaba Cloud Resource Name (ARN) of the quota. |
ApplicableType | String | discontinuous |
The type of the adjustable value. Valid values:
|
QuotaItems | Array of QuotaItems |
The details about the quota. |
|
Type | String | BaseQuota |
The category of the quota. Valid values:
|
Quota | String | 10 |
The value of the quota. |
QuotaUnit | String | AMOUNT |
The unit of the quota. Note The unit of each quota is unique. For example, the quota whose ID is
q_cbdch3 represents the maximum number of ACK clusters. The unit of this quota is clusters.
The quota whose ID is q_security-groups represents the maximum number of security groups. The unit of this quota is security
groups.
|
Usage | String | 1 |
The used quota. |
Dimensions | Map |
The quota dimensions. Format: |
|
Adjustable | Boolean | true |
Indicates whether the quota is adjustable. Valid values:
|
QuotaName | String | ecs.g5.2xlarge |
The name of the quota. |
UnadjustableDetail | String | applicationProcess |
The reason why the quota is not adjustable. Valid values:
|
Consumable | Boolean | true |
Indicates whether the system shows the used value of the quota. Valid values:
|
TotalQuota | Float | 200 |
The value of the quota. |
ProductCode | String | ecs-spec |
The abbreviation of the cloud service name. |
MaxResults | Integer | 1 |
The number of records that are returned for the query. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListProductQuotas
&ProductCode=ecs-spec
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListProductQuotasResponse>
<TotalCount>4</TotalCount>
<RequestId>F3A3568B-B01E-4EA7-B3DD-0699B4D319F9</RequestId>
<NextToken>AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX</NextToken>
<Quotas>
<QuotaDescription>ecs.g5.2xlarge</QuotaDescription>
<Consumable>true</Consumable>
<TotalUsage>3</TotalUsage>
<ProductCode>ecs-spec</ProductCode>
<Dimensions>
<regionId>cn-hangzhou</regionId>
<chargeType>PostPaid</chargeType>
<zoneId>cn-hangzhou-i</zoneId>
<networkType>vpc</networkType>
<resourceType>InstanceType</resourceType>
</Dimensions>
<QuotaUnit>AMOUNT</QuotaUnit>
<Period/>
<Adjustable>true</Adjustable>
<QuotaActionCode>ecs.g5.2xlarge</QuotaActionCode>
<QuotaName>ecs.g5.2xlarge</QuotaName>
<QuotaItems>
<Usage>0</Usage>
<Type>ReservedQuota</Type>
<Quota>0</Quota>
</QuotaItems>
<QuotaItems>
<Usage>0</Usage>
<Type>BaseQuota</Type>
<Quota>0</Quota>
</QuotaItems>
<QuotaArn>acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i</QuotaArn>
<TotalQuota>160</TotalQuota>
<ApplicableType>continuous</ApplicableType>
</Quotas>
<MaxResults>1</MaxResults>
</ListProductQuotasResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"ListProductQuotasResponse" : {
"TotalCount" : 4,
"RequestId" : "F3A3568B-B01E-4EA7-B3DD-0699B4D319F9",
"NextToken" : "AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX",
"Quotas" : {
"QuotaDescription" : "ecs.g5.2xlarge",
"Consumable" : true,
"TotalUsage" : 3,
"ProductCode" : "ecs-spec",
"Dimensions" : {
"regionId" : "cn-hangzhou",
"chargeType" : "PostPaid",
"zoneId" : "cn-hangzhou-i",
"networkType" : "vpc",
"resourceType" : "InstanceType"
},
"QuotaUnit" : "AMOUNT",
"Period" : "",
"Adjustable" : true,
"QuotaActionCode" : "ecs.g5.2xlarge",
"QuotaName" : "ecs.g5.2xlarge",
"QuotaItems" : [ {
"Usage" : 0,
"Type" : "ReservedQuota",
"Quota" : 0
}, {
"Usage" : 0,
"Type" : "BaseQuota",
"Quota" : 0
} ],
"QuotaArn" : "acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i",
"TotalQuota" : 160,
"ApplicableType" : "continuous"
},
"MaxResults" : 1
}
}
Error codes
For a list of error codes, visit the API Error Center.