Query product quotas using ListProductQuotas - Quota Center - Alibaba Cloud - Quota Center

Queries the quotas of a specified cloud service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quotas:ListProductQuotas

list

*Quota

acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token used to retrieve the next page of results. Leave this parameter empty for the first request or when no more results are available. If more results are available, set this parameter to the NextToken value returned when you invoke the previous API call.	AAAAAd****
MaxResults	integer	No	The maximum number of entries to return in a single request. Valid values: 1 to 100. Default value: 30.	30
ProductCode	string	Yes	The abbreviation of the cloud service. Note For more information about how to obtain the abbreviation of a cloud service, see `ProductCode` in ListProducts.	ecs
QuotaActionCode	string	No	The ID of the quota.	q_security-groups
KeyWord	string	No	The search keyword for the quota. Note This parameter applies only to Elastic Computing Service server instance type quotas (ecs-spec). The search scope includes `QuotaName` and `QuotaActionCode`.	security
SortField	string	No	The sorting method supported by the quota. Note This parameter applies only to Elastic Computing Service server instance type quotas (ecs-spec). If no Settings are specified, it is left empty. Valid values: TOTAL : sort by total quota usage. TIME : sort by last update time. RESERVED : sort by reserved quota usage.	TIME
SortOrder	string	No	The sorting method supported by the quota. Note This parameter applies only to Elastic Computing Service server instance type quotas (ecs-spec). If no Settings are specified, it is left empty. Valid values: Descending : descending order. Ascending : ascending order.	Ascending
Dimensions	array<object>	No	The quota dimensions.
	object	No	The quota dimensions.
Key	string	No	The key of the quota dimension. Note The value range of N depends on the number of dimensions supported by the corresponding cloud service.	regionId
Value	string	No	The value of the quota dimension. Note The value range of N depends on the number of dimensions supported by the corresponding cloud service.	cn-hangzhou
QuotaCategory	string	No	The quota category. Default value: CommonQuota. Valid values: FlowControl : API rate limit. WhiteListLabel : privilege. CommonQuota : general quota.	FlowControl
GroupCode	string	No	The code of the dimension group.	entconsole_w1j3ms****

Response elements

Element	Type	Description	Example
	object	The response.
MaxResults	integer	The maximum number of records returned for the current query.	1
NextToken	string	Indicates whether a token for the next query is available. If NextToken is empty, it indicates that no subsequent query is available. If NextToken is returned, the value is the token used to start the next query.	AAAAAd****
Quotas	array<object>	The quota details.
	array<object>	The quota details.
Adjustable	boolean	Indicates whether the quota is adjustable. Valid values: true : The quota is adjustable. false : The quota is not adjustable.	true
ApplicableRange	array	The range of quota values that can be applied for the current quota item, which serves as a reference for quota applications.
	number	The range of quota values that can be applied for the current quota item. This range excludes the existing range of the current user and serves as a reference for quota applications. Example: `[1010,10000]`.	[1010,10000]
ApplicableType	string	The quota adjustment type. Valid values: continuous : Continuous. discontinuous : Discontinuous.	discontinuous
ApplyReasonTips	string	The sample reasons for applying for a quota adjustment.	The business xxx is expected to grow by 50%.
Consumable	boolean	Indicates whether the used quota is displayed. Valid values: true : The used quota is displayed. false : The used quota is not displayed.	true
Dimensions	object	The quota dimensions. Format: `{"regionId":"region"}`.	{"regionId":"cn-hangzhou"}
EffectiveTime	string	The UTC time when the quota takes effect.	2022-09-28T06:07:00Z
ExpireTime	string	The UTC time when the quota expires.	2022-09-29T06:07:00Z
GlobalQuota	boolean	Indicates whether the quota is a global quota. Valid values: true : The quota item is shared across all regions. false : The quota item is independent for each region.	true
Period	object	The quota calculation period.
PeriodUnit	string	The unit of the quota calculation period. Valid values: week : Week. hour : Hour. day : Day. second : Second. minute : Minute.	day
PeriodValue	integer	The value of the quota calculation period.	{}
ProductCode	string	The abbreviation of the cloud service name.	ecs
QuotaActionCode	string	The ID of the quota.	q_security-groups
QuotaArn	string	The ARN of the quota.	acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups
QuotaCategory	string	The quota type. Valid values: FlowControl : API rate limit. WhiteListLabel : privilege. CommonQuota : general quota.	CommonQuota
QuotaDescription	string	The quota description.	The maximum number of security groups that can be owned by the current account.
QuotaItems	array<object>	The quota details.
	object	The quota details.
Quota	string	The quota value.	1009
QuotaUnit	string	The quota unit.	Count
Type	string	The quota category. Valid values: BaseQuota : Base quota. ReservedQuota : Reserved quota.	BaseQuota
Usage	string	The quota usage.	1009
QuotaName	string	The quota name.	ecs.g5.2xlarge
QuotaType	string	The quota type. Valid values: normal : Normal. privilege : Privilege.	privilege
QuotaUnit	string	The quota unit.	AMOUNT
SupportedRange	array	The range of quota values supported by the current quota item, which serves as a reference when you configure a quota template.
	number	The range of quota values supported by the current quota item, which serves as a reference when you configure a quota template. If ApplicableType is continuous and the value is [1009,10000], it indicates all numbers from 1009 to 10000. If ApplicableType is discontinuous and the value is [10,20,50,100], it indicates only the values 10, 20, 50, and 100.	[1009,10000]
TotalQuota	number	The quota value.	200
TotalUsage	number	The quota usage.	1009
UnadjustableDetail	string	The reason why the quota is not adjustable. Valid values: limitReached : The quota limit is reached. nonactivated : The service is not activated. applicationProcess : The quota application is being processed.	applicationProcess
UsageMetric	object	The monitoring information of the quota usage in CloudMonitor. Note An empty value indicates that no monitoring data is available for this quota in CloudMonitor.
MetricDimensions	object	The CloudMonitor monitoring dimensions. Format: a collection of `key:value` pairs. Example: `{"productCode":"*","metricKey":"","regionId":"","label":"*"}`.
	string	The CloudMonitor monitoring dimension values.	ecs
MetricName	string	The name of the CloudMonitor monitoring metric.	Usage
MetricNamespace	string	The namespace of the CloudMonitor monitoring data.	acs_quotas_flowcontrol
RequestId	string	The request ID.	D0131FD5-5397-44FE-BF5A-4B7165B813CC
TotalCount	integer	The total number of records returned for the current request.	1

Examples

Success response

JSON format

{
  "MaxResults": 1,
  "NextToken": "AAAAAd****",
  "Quotas": [
    {
      "Adjustable": true,
      "ApplicableRange": [
        0
      ],
      "ApplicableType": "discontinuous",
      "ApplyReasonTips": "The business xxx is expected to grow by 50%.",
      "Consumable": true,
      "Dimensions": {
        "regionId": "cn-hangzhou"
      },
      "EffectiveTime": "2022-09-28T06:07:00Z",
      "ExpireTime": "2022-09-29T06:07:00Z",
      "GlobalQuota": true,
      "Period": {
        "PeriodUnit": "day",
        "PeriodValue": 0
      },
      "ProductCode": "ecs",
      "QuotaActionCode": "q_security-groups",
      "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups",
      "QuotaCategory": "CommonQuota",
      "QuotaDescription": "The maximum number of security groups that can be owned by the current account.",
      "QuotaItems": [
        {
          "Quota": "1009",
          "QuotaUnit": "Count",
          "Type": "BaseQuota",
          "Usage": "1009"
        }
      ],
      "QuotaName": "ecs.g5.2xlarge",
      "QuotaType": "privilege",
      "QuotaUnit": "AMOUNT",
      "SupportedRange": [
        0
      ],
      "TotalQuota": 200,
      "TotalUsage": 1009,
      "UnadjustableDetail": "applicationProcess",
      "UsageMetric": {
        "MetricDimensions": {
          "key": "ecs"
        },
        "MetricName": "Usage",
        "MetricNamespace": "acs_quotas_flowcontrol"
      }
    }
  ],
  "RequestId": "D0131FD5-5397-44FE-BF5A-4B7165B813CC",
  "TotalCount": 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.
400	DIMENSIONGROUP.NOT.FOUND	Dimension group does not exist.	Dimension group parameter is incorrect

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.