全部产品
Search
文档中心

配额中心:ListProductQuotas - 查询目标云产品的配额列表

更新时间:Apr 15, 2024

查询目标云产品的配额列表。

接口说明

本文将提供一个示例,查询云服务 ECS 规格配额ecs.g5.2xlarge的配额列表。返回结果显示,目标配额的名称、ID、单位、维度、周期等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quotas:ListProductQuotasRead
  • Quota
    acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*

请求参数

名称类型必填描述示例值
NextTokenstring

用来标记开始查询数据的位置。置空表示从头开始。

1
MaxResultsinteger

本次查询的最大记录条数。

取值范围:1~100。默认值:30。

30
ProductCodestring

云服务名称缩写。

说明 关于支持配额中心的云服务,请参见支持配额中心的云服务
ecs-spec
QuotaActionCodestring

配额 ID。

ecs.g5.2xlarge
KeyWordstring

配额的搜索关键字。

ecs-spec
SortFieldstring

云服务 ECS 规格配额支持设置排序字段。取值:

  • TIME:按最近更新时间排序。
  • TOTAL:按总配额用量排序。
  • RESERVED:按预留配额用量排序。
TIME
SortOrderstring

云服务 ECS 规格配额支持的排序。取值:

  • Ascending:升序。
  • Descending:降序。
Ascending
Dimensionsobject []

配额维度。

Keystring

配额维度的 Key。

说明 N 的取值范围取决于对应云服务支持的维度个数。
regionId
Valuestring

配额维度的 Value。

说明 N 的取值范围取决于对应云服务支持的维度个数。
cn-hangzhou
QuotaCategorystring

配额种类。取值:

  • CommonQuota(默认值):通用配额。

  • FlowControl:API 速率配额。

  • WhiteListLabel:权益配额。

FlowControl
GroupCodestring

维度组代码。

entconsole_w1j3msbo2g

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

TotalCountinteger

本次请求返回的全部记录条数。

4
NextTokenstring

用来标记返回查询数据的位置。空表示数据已经查询完毕。

AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX
RequestIdstring

请求 ID。

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

配额详情。

QuotaUnitstring

配额单位。

说明 每个配额的单位不同。例如:容器服务 Kubernetes 版的配额q_cbdch3(最大集群数)单位为 Cluster,云服务器 ECS 的配额q_security-groups(安全组总数量上限)单位为个。
AMOUNT
QuotaActionCodestring

配额 ID。

ecs.g5.2xlarge
TotalUsagefloat

配额用量。

1
ApplicableRangearray

无。

float

当前配额项可申请的配额值区间。

排除当前用户已有区间,用于申请配额时进行参考,例如:[802,10000]

[802,10000]
SupportedRangearray

无。

float

当前配额项支持的配额值区间,用于配置配额模板时进行参考。

  • 当 ApplicableType 为 continuous 时,如果取值为[802,1000],则表示取值为 802~1000 中的所有数。

  • 当 ApplicableType 为 discontinuous 时,如果取值为[10,20,50,100],则表示取值仅为 10、20、50 和 100。

[802,1000]
QuotaTypestring

配额类型。取值:

  • privilege:特权。

  • normal:普通。

privilege
QuotaDescriptionstring

配额描述。

ecs.g5.2xlarge
Periodobject

配额计算周期。

PeriodValueinteger

配额计算周期的取值。

1
PeriodUnitstring

配额计算周期的单位。取值:

  • second:秒。

  • minute:分钟。

  • hour:小时。

  • day:天。

  • week:周。

day
QuotaArnstring

配额 ARN。

acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i
ApplicableTypestring

配额调整类型。取值:

  • continuous:连续。

  • discontinuous:间断。

discontinuous
QuotaItemsobject []

配额详情。

Typestring

配额类别。取值:

  • BaseQuota:保障配额。

  • ReservedQuota:预留配额。

BaseQuota
Quotastring

配额值。

10
QuotaUnitstring

配额单位。

说明 每个配额的单位不同。例如:容器服务 Kubernetes 版的配额q_cbdch3(最大集群数)单位为 Cluster,云服务器 ECS 的配额q_security-groups(安全组总数量上限)单位为个。
AMOUNT
Usagestring

配额用量。

1
Dimensionsobject

配额维度。格式:{"regionId":"地域"}

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

配额是否可调整。取值:

  • true:配额可调整。

  • false:配额不可调整。

true
QuotaNamestring

配额名称。

ecs.g5.2xlarge
UnadjustableDetailstring

配额不可调整原因。取值:

  • nonactivated:未开通服务。

  • applicationProcess:配额申请处理中。

  • limitReached:已达配额上限。

applicationProcess
Consumableboolean

是否显示“已使用”的配额。取值:

  • true:显示“已使用”的配额。

  • false:不显示“已使用”的配额。

true
TotalQuotafloat

配额值。

200
ProductCodestring

云服务名称缩写。

ecs-spec
EffectiveTimestring

配额生效的 UTC 时间。

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

配额失效的 UTC 时间。

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

配额类型。

  • CommonQuota:通用配额。
  • FlowControl:API 速率配额。
  • WhiteListLabel:权益配额。
CommonQuota
ApplyReasonTipsstring

申请配额调整理由示例。

申请业务:xxx 业务规模预计增长:50%
GlobalQuotaboolean

是否为全局配额。取值:

  • true:该配额项为所有 Region 共用。
  • false:该配额项为每个 Region 独立。
true
MaxResultsinteger

本次查询返回的最大记录条数。

1

示例

正常返回示例

JSON格式

{
  "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": "申请业务:xxx\n业务规模预计增长:50%",
      "GlobalQuota": true
    }
  ],
  "MaxResults": 1
}

错误码

HTTP status code错误码错误信息描述
400InvalidSortOrderInvalid SortOrder参数SortOrder无效。
400INVALID.MAX.RESULTSThe maxResults parameter is invalid. Use an integer ranging from 1 to 100.maxResults参数不合法,请使用1~100范围内的整数。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-09-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-06-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-12-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更