All Products
Search
Document Center

Quota Center:GetProductQuota

Last Updated:Nov 16, 2023

Queries the details of the specified quota.

Operation Description

In this example, the operation is called to query the details of a quota whose ID is q_security-groups and whose name is Maximum Number of Security Groups. This quota belongs to Elastic Compute Service (ECS). The query result shows the details of the quota. The details include the name, ID, description, quota value, used quota, unit, and dimension of the quota. In this example, the quota name is Maximum Number of Security Groups. The quota ID is q_security-groups. The description is The maximum number of security groups that can be created for the current account. The quota value is 801. The used quota is 26. The quota unit is Number of security groups. The quota dimension is {"regionId":"cn-hangzhou"}.

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

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The abbreviation of the Alibaba Cloud service name.

Note For more information, see Alibaba Cloud services that support Quota Center.
Enumeration Value:
  • ecs
  • entconsole
  • eip
  • ecs-spec
ecs
QuotaActionCodestringYes

The ID of the quota.

q_security-groups
Dimensionsobject []No

The quota dimensions.

{\"regionId\":\"cn-beijing\"}
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.
  • If you call the operation to query the details of a quota that belongs to a cloud service that supports dimensions, you must configure this parameter. You must configure the Dimensions.N.Key and Dimensions.N.Value parameters at the same time. The following cloud services support dimensions: ECS whose service code is ecs, Enterprise Distributed Application Service (EDAS) whose service code is edas, ECS Quotas by Instance Type whose service code is ecs-spec, and Auto Scaling (ESS) whose service code is ess.
  • 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.
  • If you call the operation to query the details of a quota that belongs to a cloud service that supports dimensions, you must configure this parameter. You must configure the Dimensions.N.Key and Dimensions.N.Value parameters at the same time. The following cloud services support dimensions: ECS whose service code is ecs, EDAS whose service code is edas, ECS Quotas by Instance Type whose service code is ecs-spec, and ESS whose service code is ess.
  • cn-hangzhou

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    None.

    RequestIdstring

    The ID of the request.

    8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3
    Quotaobject

    The details of the quota.

    QuotaUnitstring

    The unit of the new quota value.

    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.
    Count
    QuotaActionCodestring

    The ID of the quota.

    q_security-groups
    TotalUsagefloat

    The used quota.

    26
    ApplicableRangearray

    The range of the quota value.

    float

    The range of the quota value. Example: [802,10000].

    802
    SupportedRangearray

    The range of the quota value.

    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 (default value)
    normal
    QuotaDescriptionstring

    The description of the quota.

    The maximum number of security groups that can be owned by the current account
    Periodobject

    The calculation cycle of the quota.

    PeriodValueinteger

    The value of the calculation cycle of the quota.

    1
    PeriodUnitstring

    The unit of the calculation cycle of the quota. Valid values:

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

    The Alibaba Cloud Resource Name (ARN) of the quota.

    acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/
    ApplicableTypestring

    The type of the adjustable value. Valid values:

    • continuous
    • discontinuous
    continuous
    QuotaItemsobject []

    The details of the quotas.

    Typestring

    The category of the quota. Valid values:

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

    The value of the quota.

    801
    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 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.
    Count
    Usagestring

    The used quota.

    26
    Dimensionsobject

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

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

    Indicates whether the quota is adjustable. Valid values:

    • true
    • false
    true
    QuotaNamestring

    The name of the quota.

    Maximum Number of Security Groups
    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.
    • supportTicketRequired: The quota can be increased only by submitting a ticket.
    limitReached
    Consumableboolean

    Indicates whether the system shows the used value of the quota. Valid values:

    • true
    • false
    true
    TotalQuotafloat

    The value of the quota.

    801
    ProductCodestring

    The abbreviation of the Alibaba Cloud service name.

    ecs
    EffectiveTimestring

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

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

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

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

    The type of the quota. Valid values:

    • CommonQuota: general quota
    • FlowControl: API rate limit
    • WhiteListLabel: whitelist quota
    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

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3",
      "Quota": {
        "QuotaUnit": "Count\n",
        "QuotaActionCode": "q_security-groups",
        "TotalUsage": 26,
        "ApplicableRange": [
          802
        ],
        "SupportedRange": [
          0
        ],
        "QuotaType": "normal",
        "QuotaDescription": "The maximum number of security groups that can be owned by the current account\n",
        "Period": {
          "PeriodValue": 1,
          "PeriodUnit": "Day"
        },
        "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/",
        "ApplicableType": "continuous",
        "QuotaItems": [
          {
            "Type": "BaseQuota",
            "Quota": "801",
            "QuotaUnit": "Count\n",
            "Usage": "26"
          }
        ],
        "Dimensions": {
          "regionId": "cn-hangzhou"
        },
        "Adjustable": true,
        "QuotaName": "Maximum Number of Security Groups\n",
        "UnadjustableDetail": "limitReached",
        "Consumable": true,
        "TotalQuota": 801,
        "ProductCode": "ecs",
        "EffectiveTime": "2022-09-28T06:06:00Z",
        "ExpireTime": "2022-09-29T06:06:00Z",
        "QuotaCategory": "CommonQuota",
        "ApplyReasonTips": "The business xxx is expected to grow by 50%.\n",
        "GlobalQuota": true
      }
    }

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-11-07The response structure of the API operation changes.see changesets
    Change itemChange content
    Output ParametersThe response structure of the API operation changes.
    2023-06-28The response structure of the API operation changes.see changesets
    Change itemChange content
    Output ParametersThe response structure of the API operation changes.
    2023-03-17The internal configurations of the API operation change but you can still call the operation.see changesets
    Change itemChange content
    The internal configurations of the API operation change but you can still call the operation.