GetProductQuota - Quota Center - Alibaba Cloud Documentation Center

Queries the details of a quota for a specified Alibaba 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:GetProductQuota

get

*Quota

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	Yes	The abbreviation of the Alibaba Cloud product name. Note For more information, see the ProductCode parameter in ListProducts.	ecs
QuotaActionCode	string	Yes	The quota ID. Note For more information, see the QuotaActionCode parameter in ListProductQuotas.	q_security-groups
Dimensions	array<object>	No	The quota dimensions. A quota dimension is a property of a quota. The combination of Dimensions and QuotaActionCode uniquely identifies a quota. Note Dimensions are required for some Alibaba Cloud products. You can call the ListProductQuotaDimensions operation to query the dimensions of a quota and check whether the dimensions are required. The Requisite parameter in the response indicates whether a dimension is required.	{\"regionId\":\"cn-beijing\"}
	object	No	The quota dimensions.
Key	string	No	The key of the quota dimension. Note Dimensions.N.Key and Dimensions.N.Value must be specified at the same time. The value of N is determined by the number of dimensions that the Alibaba Cloud product supports. You can call the ListProductQuotaDimensions operation to query the supported dimensions. The value of N is the length of the returned array.	regionId
Value	string	No	The value of the quota dimension. Note Dimensions.N.Key and Dimensions.N.Value must be specified at the same time. The value of N is determined by the number of dimensions that the Alibaba Cloud product supports. You can call the ListProductQuotaDimensions operation to query the supported dimensions. The value of N is the length of the returned array.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
Quota	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 adjustable range of the quota.
	number	The adjustable range of the quota. For example: `[802,10000]`.	802
ApplicableType	string	The type of the adjustable quota. Valid values: continuous: The quota value is continuous. discontinuous: The quota value is discontinuous.	continuous
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":"The region ID"}`.	{"regionId":"cn-hangzhou"}
EffectiveTime	string	The UTC time when the quota takes effect.	2022-09-28T06:06:00Z
ExpireTime	string	The UTC time when the quota expires.	2022-09-29T06:06:00Z
GlobalQuota	boolean	Indicates whether the quota is a global quota. Valid values: true: The quota is shared across all regions. false: The quota is independent for each region.	true
Period	object	The calculation period of the quota.
PeriodUnit	string	The unit of the calculation period. Valid values: second minute hour day week	day
PeriodValue	integer	The value of the calculation period.	1
ProductCode	string	The abbreviation of the Alibaba Cloud product name.	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 category of the quota. Valid values: CommonQuota: general quota. FlowControl: API rate limit. WhiteListLabel: privilege.	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 quota type.
Quota	string	The quota value.	801
QuotaUnit	string	The unit of the quota. Note The units of quotas vary. For example, the unit of the `q_cbdch3` quota, which is the maximum number of clusters, for Container Service for Kubernetes (ACK) is Cluster. The unit of the `q_security-groups` quota, which is the maximum number of security groups, for Elastic Compute Service (ECS) is Count.	Count
Type	string	The quota type. Valid values: BaseQuota ReservedQuota	BaseQuota
Usage	string	The used quota.	26
QuotaName	string	The name of the quota.	Maximum Number of Security Groups
QuotaType	string	The type of the quota. Valid values: privilege normal	normal
QuotaUnit	string	The unit of the quota. Note The units of quotas vary. For example, the unit of the `q_cbdch3` quota, which is the maximum number of clusters, for Container Service for Kubernetes (ACK) is Cluster. The unit of the `q_security-groups` quota, which is the maximum number of security groups, for Elastic Compute Service (ECS) is Count.	Count
SupportedRange	array	The range of the quota value that is supported by the quota. You can refer to this range when you configure a quota template.
	number	The range of the quota value that is supported by the quota. You can refer to this range when you configure a quota template. If ApplicableType is set to continuous and the value of this parameter is [802,1000], the quota value can be any integer from 802 to 1000. If ApplicableType is set to discontinuous and the value of this parameter is [10,20,50,100], the quota value can be 10, 20, 50, or 100.	[802,1000]
TotalQuota	number	The quota value.	801
TotalUsage	number	The used quota.	26
UnadjustableDetail	string	The reason why the quota is not adjustable. Valid values: nonactivated: The service is not activated. applicationProcess: The quota increase request is being processed. limitReached: The quota limit is reached. supportTicketRequired: You must submit a ticket to request a quota increase.	limitReached
UsageMetric	object	The information about the monitoring of the quota usage in CloudMonitor. Note If this parameter is empty, no monitoring data is available in CloudMonitor.
MetricDimensions	object	The dimensions for monitoring the quota usage in CloudMonitor. Format: a collection of key-value pairs. For example: `{"productCode":"*","metricKey":"","regionId":"","label":"*"}`.
	string	The value of a dimension for monitoring the quota usage in CloudMonitor.	ecs
MetricName	string	The name of the metric for monitoring the quota usage in CloudMonitor.	Usage
MetricNamespace	string	The namespace of the metric for monitoring the quota usage in CloudMonitor.	acs_quotas_flowcontrol
RequestId	string	The request ID.	8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3

Examples

Success response

JSON format

{
  "Quota": {
    "Adjustable": true,
    "ApplicableRange": [
      802
    ],
    "ApplicableType": "continuous",
    "ApplyReasonTips": "The business xxx is expected to grow by 50%.",
    "Consumable": true,
    "Dimensions": {
      "regionId": "cn-hangzhou"
    },
    "EffectiveTime": "2022-09-28T06:06:00Z",
    "ExpireTime": "2022-09-29T06:06:00Z",
    "GlobalQuota": true,
    "Period": {
      "PeriodUnit": "day",
      "PeriodValue": 1
    },
    "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": "801",
        "QuotaUnit": "Count",
        "Type": "BaseQuota",
        "Usage": "26"
      }
    ],
    "QuotaName": "Maximum Number of Security Groups",
    "QuotaType": "normal",
    "QuotaUnit": "Count",
    "SupportedRange": [
      0
    ],
    "TotalQuota": 801,
    "TotalUsage": 26,
    "UnadjustableDetail": "limitReached",
    "UsageMetric": {
      "MetricDimensions": {
        "key": "ecs"
      },
      "MetricName": "Usage",
      "MetricNamespace": "acs_quotas_flowcontrol"
    }
  },
  "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.