ListProductQuotas - Quota Center - Alibaba Cloud Documentation Center

Queries the quotas of a specific Alibaba Cloud service.

Operation Description

In this example, the operation is called to query the quotas whose instance type is ecs.g5.2xlarge. The quotas belong to Elastic Compute Service (ECS) Quotas by Instance Type. The query result includes the name, ID, unit, dimensions, and cycle of each quota.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that marks the position from which you want to start the query. If you leave this parameter empty, the query starts from the beginning.	1
MaxResults	integer	No	The maximum number of records that can be returned for the query. Valid values: 1 to 100. Default value: 30.	30
ProductCode	string	Yes	The abbreviation of the Alibaba Cloud service name. Note For more information, see Alibaba Cloud services that support Quota Center.	ecs-spec
QuotaActionCode	string	No	The ID of the quota.	ecs.g5.2xlarge
KeyWord	string	No	The keyword that you want to use to search for the quotas.	ecs-spec
SortField	string	No	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: TIME: The returned records are sorted by the last update time. TOTAL: The returned records are sorted by the usage of the total quota. RESERVED: The returned records are sorted by the usage of the reserved quota.	TIME
SortOrder	string	No	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: Ascending: ascending order Descending: descending order	Ascending
Dimensions	object []	No	The quota dimensions.
Key	string	No	The key of the dimension. Note The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.	regionId
Value	string	No	The value of the dimension. Note The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.	cn-hangzhou
QuotaCategory	string	No	The type of the quota. Valid values: CommonQuota (default value): general quota FlowControl: API rate limit WhiteListLabel: whitelist quota	FlowControl
GroupCode	string	No	The code of the dimension group.	entconsole_w1j3msbo2g

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object	None.
TotalCount	integer	The total number of records that are returned for the query.	4
NextToken	string	The token that marks the position at which the query ends. An empty value indicates that all data is returned.	AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX
RequestId	string	The ID of the request.	D0131FD5-5397-44FE-BF5A-4B7165B813CC
Quotas	object []	The queried quotas.
QuotaUnit	string	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.	AMOUNT
QuotaActionCode	string	The quota ID.	ecs.g5.2xlarge
TotalUsage	float	The quota usage.	1
ApplicableRange	array	None.
	float	The range of the quota value that can be requested for the current quota item. The range excludes the existing quota values of the current Alibaba Cloud account. When you request a quota, you can use the range as a reference. Example: `[802,10000]`.	[802,10000]
SupportedRange	array	None.
	float	The range of the quota value that can be requested for the current quota item. When you configure a quota template, you can use the range as a reference. If the value of the ApplicableType parameter is continuous and the value of the ApplicableRange parameter is [802,1000], the quota value ranges from 802 to 1,000. If the value of the ApplicableType parameter is discontinuous and the value of the ApplicableRange parameter is [10,20,50,100], the quota value is 10, 20, 50, or 100.	[802,1000]
QuotaType	string	The type of the quota. Valid values: privilege normal	privilege
QuotaDescription	string	The description of the quota.	ecs.g5.2xlarge
Period	object	The calculation cycle of the quota.
PeriodValue	integer	The value of the calculation cycle.	1
PeriodUnit	string	The unit of the calculation cycle. Valid values: second minute hour day week	day
QuotaArn	string	The Alibaba Cloud Resource Name (ARN) of the quota.	acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i
ApplicableType	string	The type of the adjustable value. Valid values: continuous discontinuous	discontinuous
QuotaItems	object []	The details of the quota.
Type	string	The category of the quota. Valid values: BaseQuota: base quota ReservedQuota: reserved quota	BaseQuota
Quota	string	The quota value.	10
QuotaUnit	string	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.	AMOUNT
Usage	string	The quota usage.	1
Dimensions	object	The quota dimensions. Format: `{"regionId":"Region"}`.	{"regionId":"cn-hangzhou"}
Adjustable	boolean	Indicates whether the quota is adjustable. Valid values: true: The quota is adjustable. false: The quota is not adjustable.	true
QuotaName	string	The quota name.	ecs.g5.2xlarge
UnadjustableDetail	string	The reason why the quota is not adjustable. Valid values: nonactivated: The service is not activated. applicationProcess: The application is being processed. limitReached: The quota limit is reached.	applicationProcess
Consumable	boolean	Indicates whether the system shows the used value of the quota. Valid values: true: The system shows the used value of the quota. false: The system does not show the used value of the quota.	true
TotalQuota	float	The quota value.	200
ProductCode	string	The abbreviation of the Alibaba Cloud service name.	ecs-spec
EffectiveTime	string	The start time of the validity period of the quota. The value is displayed in UTC.	2022-09-28T06:07:00Z
ExpireTime	string	The end time of the validity period of the quota. The value is displayed in UTC.	2022-09-29T06:07:00Z
QuotaCategory	string	The type of the quota. Valid values: CommonQuota: general quota FlowControl: API rate limit WhiteListLabel: privilege	CommonQuota
ApplyReasonTips	string	The reason for submitting a quota increase request.	The business xxx is expected to grow by 50%.
MaxResults	integer	The maximum number of records that are returned for the query.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 4,
  "NextToken": "AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX",
  "RequestId": "D0131FD5-5397-44FE-BF5A-4B7165B813CC",
  "Quotas": [
    {
      "QuotaUnit": "AMOUNT",
      "QuotaActionCode": "ecs.g5.2xlarge",
      "TotalUsage": 1,
      "ApplicableRange": [
        0
      ],
      "SupportedRange": [
        0
      ],
      "QuotaType": "privilege",
      "QuotaDescription": "ecs.g5.2xlarge",
      "Period": {
        "PeriodValue": 1,
        "PeriodUnit": "day"
      },
      "QuotaArn": "acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i",
      "ApplicableType": "discontinuous",
      "QuotaItems": [
        {
          "Type": "BaseQuota",
          "Quota": "10",
          "QuotaUnit": "AMOUNT",
          "Usage": "1"
        }
      ],
      "Dimensions": {
        "regionId": "cn-hangzhou"
      },
      "Adjustable": true,
      "QuotaName": "ecs.g5.2xlarge",
      "UnadjustableDetail": "applicationProcess",
      "Consumable": true,
      "TotalQuota": 200,
      "ProductCode": "ecs-spec",
      "EffectiveTime": "2022-09-28T06:07:00Z",
      "ExpireTime": "2022-09-29T06:07:00Z",
      "QuotaCategory": "CommonQuota",
      "ApplyReasonTips": "The business xxx is expected to grow by 50%.\n",
      "GlobalQuota": true
    }
  ],
  "MaxResults": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSortOrder	Invalid SortOrder	The specified SortOrder parameter is invalid.
400	INVALID.MAX.RESULTS	The maxResults parameter is invalid. Use an integer ranging from 1 to 100.	The maxResults value is invalid. It must be an integer within the range of 1 to 100.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-11-07

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2023-09-22

API Description Update,The error codes of the API operation change.

see changesets

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400

2023-06-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-12-02

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.