All Products
Search
Document Center

Quota Center:ListProductQuotas

Last Updated:Dec 18, 2023

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

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
MaxResultsintegerNo

The maximum number of records that can be returned for the query.

Valid values: 1 to 100. Default value: 30.

30
ProductCodestringYes

The abbreviation of the Alibaba Cloud service name.

Note For more information, see Alibaba Cloud services that support Quota Center.
ecs-spec
QuotaActionCodestringNo

The ID of the quota.

ecs.g5.2xlarge
KeyWordstringNo

The keyword that you want to use to search for the quotas.

ecs-spec
SortFieldstringNo

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
SortOrderstringNo

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
Dimensionsobject []No

The quota dimensions.

KeystringNo

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
ValuestringNo

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
QuotaCategorystringNo

The type of the quota. Valid values:

  • CommonQuota (default value): general quota
  • FlowControl: API rate limit
  • WhiteListLabel: whitelist quota
FlowControl
GroupCodestringNo

The code of the dimension group.

entconsole_w1j3msbo2g

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

Response parameters

ParameterTypeDescriptionExample
object

None.

TotalCountinteger

The total number of records that are returned for the query.

4
NextTokenstring

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
RequestIdstring

The ID of the request.

D0131FD5-5397-44FE-BF5A-4B7165B813CC
Quotasobject []

The queried quotas.

QuotaUnitstring

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
QuotaActionCodestring

The quota ID.

ecs.g5.2xlarge
TotalUsagefloat

The quota usage.

1
ApplicableRangearray

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]
SupportedRangearray

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]
QuotaTypestring

The type of the quota. Valid values:

  • privilege
  • normal
privilege
QuotaDescriptionstring

The description of the quota.

ecs.g5.2xlarge
Periodobject

The calculation cycle of the quota.

PeriodValueinteger

The value of the calculation cycle.

1
PeriodUnitstring

The unit of the calculation cycle. Valid values:

  • second
  • minute
  • hour
  • day
  • week
day
QuotaArnstring

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
ApplicableTypestring

The type of the adjustable value. Valid values:

  • continuous
  • discontinuous
discontinuous
QuotaItemsobject []

The details of the quota.

Typestring

The category of the quota. Valid values:

  • BaseQuota: base quota
  • ReservedQuota: reserved quota
BaseQuota
Quotastring

The quota value.

10
QuotaUnitstring

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
Usagestring

The quota usage.

1
Dimensionsobject

The quota dimensions. Format: {"regionId":"Region"}.

{"regionId":"cn-hangzhou"}
Adjustableboolean

Indicates whether the quota is adjustable. Valid values:

  • true: The quota is adjustable.
  • false: The quota is not adjustable.
true
QuotaNamestring

The quota name.

ecs.g5.2xlarge
UnadjustableDetailstring

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
Consumableboolean

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
TotalQuotafloat

The quota value.

200
ProductCodestring

The abbreviation of the Alibaba Cloud service name.

ecs-spec
EffectiveTimestring

The start time of the validity period of the quota. The value is displayed in UTC.

2022-09-28T06:07:00Z
ExpireTimestring

The end time of the validity period of the quota. The value is displayed in UTC.

2022-09-29T06:07:00Z
QuotaCategorystring

The type of the quota. Valid values:

  • CommonQuota: general quota
  • FlowControl: API rate limit
  • WhiteListLabel: privilege
CommonQuota
ApplyReasonTipsstring

The reason for submitting a quota increase request.

The business xxx is expected to grow by 50%.
GlobalQuotaboolean

Indicates whether the quota is a global quota. Valid values:

  • true: The quota is shared in all regions.
  • false: The quota is independently used in a region.
true
MaxResultsinteger

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 codeError codeError messageDescription
400InvalidSortOrderInvalid SortOrderThe specified SortOrder parameter is invalid.
400INVALID.MAX.RESULTSThe 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 timeSummary of changesOperation
2023-11-07The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-09-22API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-06-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-12-02The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.