ListProductQuotas - Quota Center - Alibaba Cloud Documentation Center

Queries a list of quotas for a specified cloud product.

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 that is used to initiate the next query. Leave this parameter empty for the first query or if no subsequent query is needed. If a subsequent query is needed, set the value to the NextToken value that is returned from the last API call.	AAAAAd****
MaxResults	integer	No	The maximum number of records to return for the query. Valid values: 1 to 100. Default value: 30.	30
ProductCode	string	Yes	The abbreviation of the cloud product. Note For more information about how to obtain the abbreviation of a cloud product, see the `ProductCode` parameter in ListProducts.	ecs
QuotaActionCode	string	No	The quota ID.	q_security-groups
KeyWord	string	No	The keyword to use for searching quotas. Note This parameter is applicable only to instance type quotas of Elastic Compute Service (ECS). The search is performed on `QuotaName` and `QuotaActionCode`.	security
SortField	string	No	The field to use for sorting the quotas. Note This parameter is applicable only to instance type quotas of ECS. If you do not set this parameter, the query results are not sorted. Valid values: TOTAL : Sorts by total quota usage. TIME : Sorts by the last update time. RESERVED : Sorts by reserved quota usage.	TIME
SortOrder	string	No	The order to sort the results. Note This parameter is applicable only to instance type quotas of ECS. If you do not set this parameter, the query results are not sorted. Valid values: Descending : Sorts in descending order. Ascending : Sorts in 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 of N depends on the number of dimensions that are supported by the cloud product.	regionId
Value	string	No	The value of the quota dimension. Note The value of N depends on the number of dimensions that are supported by the cloud product.	cn-hangzhou
QuotaCategory	string	No	The quota category. Default value: CommonQuota. Valid values: FlowControl : API rate limit quotas WhiteListLabel : Privilege quotas CommonQuota : General quotas	FlowControl
GroupCode	string	No	The code of the dimension group.	entconsole_w1j3ms****

Response elements

Element	Type	Description	Example
	object	The returned result.
MaxResults	integer	The maximum number of records returned for the query.	1
NextToken	string	The token that is used to initiate the next query. If this parameter is empty, no subsequent query is to be initiated. If a value is returned, the value is the token that is used for the next query.	AAAAAd****
Quotas	array<object>	The details of the quotas.
	array<object>	The details of the quota.
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 the quota value that you can request for the quota. This can be used as a reference for quota increase requests.
	number	The range of the quota value that you can request. This range does not include the existing quota of the user. You can use this as a reference when you request a quota increase. For example, `[1010,10000]`.	[1010,10000]
ApplicableType	string	The type of the quota adjustment. Valid values: continuous : The quota value is continuous. discontinuous : The quota value is discontinuous.	discontinuous
ApplyReasonTips	string	An example of the reason for a quota increase request.	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 is shared by all regions. false : The quota is independent for each region.	true
Period	object	The calculation cycle of the quota.
PeriodUnit	string	The unit of the calculation cycle. Valid values: week : Week hour : Hour day : Day second : Seconds minute : minutes	day
PeriodValue	integer	The value of the calculation cycle.	{}
ProductCode	string	The abbreviation of the cloud product.	ecs
QuotaActionCode	string	The quota ID.	q_security-groups
QuotaArn	string	The Alibaba Cloud Resource Name (ARN) of the quota.	acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups
QuotaCategory	string	The quota category. Valid values: FlowControl : API rate limit quotas WhiteListLabel : Privilege quotas CommonQuota : General quotas	CommonQuota
QuotaDescription	string	The description of the quota.	The maximum number of security groups that can be owned by the current account.
QuotaItems	array<object>	The details of the quota.
	object	The details of the quota.
Quota	string	The quota value.	1009
QuotaUnit	string	The unit of the quota.	Count
Type	string	The quota type. Valid values: BaseQuota : Guaranteed quota ReservedQuota : Reserved quota	BaseQuota
Usage	string	The quota usage.	1009
QuotaName	string	The name of the quota.	ecs.g5.2xlarge
QuotaType	string	The quota type. Valid values: normal : Standard privilege : Privileges	privilege
QuotaUnit	string	The unit of the quota.	AMOUNT
SupportedRange	array	The range of the quota value that is supported by the quota. This can be used as a reference when you configure a quota template.
	number	The range of the quota value that is supported by the quota. This can be used as a reference when you configure a quota template. If ApplicableType is continuous, and the value is [1009,10000], it indicates that all values from 1009 to 10000 are supported. If ApplicableType is discontinuous, and the value is [10,20,50,100], it indicates that only the values 10, 20, 50, and 100 are supported.	[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 : A quota increase request 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 the quota in CloudMonitor.
MetricDimensions	object	The dimensions for CloudMonitor. Format: a collection of key-value pairs. For example: `{"productCode":"*","metricKey":"","regionId":"","label":"*"}`.
	string	The value of the dimension for CloudMonitor.	ecs
MetricName	string	The name of the CloudMonitor metric.	Usage
MetricNamespace	string	The namespace of the metric for CloudMonitor.	acs_quotas_flowcontrol
RequestId	string	The request ID.	D0131FD5-5397-44FE-BF5A-4B7165B813CC
TotalCount	integer	The total number of records returned for the 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.