文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

是否拥有下一次查询的令牌(Token)。

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
AAAAAd****
MaxResultsinteger

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

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

30
ProductCodestring

云产品的缩写名称。

说明 关于如何获取云产品的缩写名称,请参见 ListProducts 中的ProductCode
ecs
QuotaActionCodestring

配额 ID。

q_security-groups
KeyWordstring

配额的搜索关键字。

说明 该参数仅针对云服务器 ECS 规格配额(ecs-spec),搜索范围:QuotaNameQuotaActionCode
security
SortFieldstring

配额支持的排序方式。

说明 该参数仅针对云服务器 ECS 规格配额(ecs-spec),如果不设置,则为空。
枚举值:
  • TOTAL按总配额用量排序
  • TIME按最近更新时间排序
  • RESERVED按预留配额用量排序
TIME
SortOrderstring

配额支持的排序方式。

说明 该参数仅针对云服务器 ECS 规格配额(ecs-spec),如果不设置,则为空。
枚举值:
  • Descending降序
  • Ascending升序
Ascending
Dimensionsarray<object>

配额维度。

object

配额维度。

Keystring

配额维度的 Key。

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

配额维度的 Value。

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

配额种类。

默认值:CommonQuota。

枚举值:
  • FlowControlAPI速率配额
  • WhiteListLabel权益配额
  • CommonQuota通用配额
FlowControl
GroupCodestring

维度组代码。

entconsole_w1j3msbo2g

返回参数

名称类型描述示例值
object

返回结果。

MaxResultsinteger

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

1
NextTokenstring

是否拥有下一次查询的令牌(Token)。

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
AAAAAd****
Quotasarray<object>

配额详情。

Quotasobject

配额详情。

Adjustableboolean

配额是否可调整。

枚举值:
  • true配额可调整
  • false配额不可调整
true
ApplicableRangearray

当前配额项可申请的配额值区间,用于配额申请时进行参考。

ApplicableRangefloat

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

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

[1010,10000]
ApplicableTypestring

配额调整类型。

枚举值:
  • continuous连续
  • discontinuous间断
discontinuous
ApplyReasonTipsstring

申请配额调整理由示例。

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

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

枚举值:
  • true显示“已使用”的配额
  • false不显示“已使用”的配额
true
Dimensionsobject

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

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

配额生效的 UTC 时间。

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

配额失效的 UTC 时间。

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

是否为全局配额。

枚举值:
  • true该配额项为所有Region共用
  • false该配额项为每个Region独立
true
Periodobject

配额计算周期。

PeriodUnitstring

配额计算周期的单位。

枚举值:
  • week
  • hour小时
  • day
  • second
  • minute分钟
day
PeriodValueinteger

配额计算周期的取值。

{}
ProductCodestring

云产品名称缩写。

ecs
QuotaActionCodestring

配额 ID。

q_security-groups
QuotaArnstring

配额 ARN。

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

配额类型。

枚举值:
  • FlowControlAPI速率配额
  • WhiteListLabel权益配额
  • CommonQuota通用配额
CommonQuota
QuotaDescriptionstring

配额描述。

当前账户可拥有的安全组的最大数量
QuotaItemsarray<object>

配额详情。

QuotaItemsobject

配额详情。

Quotastring

配额值。

1009
QuotaUnitstring

配额单位。

Typestring

配额类别。

枚举值:
  • BaseQuota保障配额
  • ReservedQuota预留配额
BaseQuota
Usagestring

配额用量。

1009
QuotaNamestring

配额名称。

ecs.g5.2xlarge
QuotaTypestring

配额类型。

枚举值:
  • normal普通
  • privilege特权
privilege
QuotaUnitstring

配额单位。

SupportedRangearray

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

SupportedRangefloat

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

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

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

[1009,10000]
TotalQuotafloat

配额值。

200
TotalUsagefloat

配额用量。

1009
UnadjustableDetailstring

配额不可调整原因。

枚举值:
  • limitReached已达配额上限
  • nonactivated未开通服务
  • applicationProcess配额申请处理中
applicationProcess
UsageMetricobject

配额用量在云监控(CloudMonitor)中的监控信息。

说明 空表示云监控中无此配额监控数据。
MetricDimensionsobject

CloudMonitor 监控维度。

格式:key:value键值对形式的集合,例如: {"productCode":"***","metricKey":"***","regionId":"***","label":"***"}

string

CloudMonitor 监控维度值。

ecs
MetricNamestring

CloudMonitor 监控项名称。

Usage
MetricNamespacestring

CloudMonitor 监控数据命名空间。

acs_quotas_flowcontrol
RequestIdstring

请求 ID。

D0131FD5-5397-44FE-BF5A-4B7165B813CC
TotalCountinteger

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

1

示例

正常返回示例

JSON格式

{
  "MaxResults": 1,
  "NextToken": "AAAAAd****",
  "Quotas": [
    {
      "Adjustable": true,
      "ApplicableRange": [
        0
      ],
      "ApplicableType": "discontinuous",
      "ApplyReasonTips": "申请业务:xxx\n业务规模预计增长: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": "当前账户可拥有的安全组的最大数量",
      "QuotaItems": [
        {
          "Quota": "1009",
          "QuotaUnit": "个",
          "Type": "BaseQuota",
          "Usage": "1009"
        }
      ],
      "QuotaName": "ecs.g5.2xlarge",
      "QuotaType": "privilege",
      "QuotaUnit": "个",
      "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
}

错误码

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 返回结构发生变更查看变更详情
2023-09-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-06-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-12-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情