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

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quotas:ListProductQuotas

list

*Quota

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

请求参数

名称

类型

必填

描述

示例值

NextToken

string

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

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

AAAAAd****

MaxResults

integer

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

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

30

ProductCode

string

云产品的缩写名称。

说明

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

ecs

QuotaActionCode

string

配额 ID。

q_security-groups

KeyWord

string

配额的搜索关键字。

说明

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

security

SortField

string

配额支持的排序方式。

说明

该参数仅针对云服务器 ECS 规格配额(ecs-spec),如果不设置,则为空。

枚举值:

  • TOTAL :

    按总配额用量排序

  • TIME :

    按最近更新时间排序

  • RESERVED :

    按预留配额用量排序

TIME

SortOrder

string

配额支持的排序方式。

说明

该参数仅针对云服务器 ECS 规格配额(ecs-spec),如果不设置,则为空。

枚举值:

  • Descending :

    降序

  • Ascending :

    升序

Ascending

Dimensions

array<object>

配额维度。

object

配额维度。

Key

string

配额维度的 Key。

说明

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

regionId

Value

string

配额维度的 Value。

说明

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

cn-hangzhou

QuotaCategory

string

配额种类。

默认值:CommonQuota。

枚举值:

  • FlowControl :

    API 速率配额

  • WhiteListLabel :

    权益配额

  • CommonQuota :

    通用配额

FlowControl

GroupCode

string

维度组代码。

entconsole_w1j3ms****

返回参数

名称

类型

描述

示例值

object

返回结果。

MaxResults

integer

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

1

NextToken

string

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

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

AAAAAd****

Quotas

array<object>

配额详情。

object

配额详情。

Adjustable

boolean

配额是否可调整。

枚举值:

  • true :

    配额可调整

  • false :

    配额不可调整

true

ApplicableRange

array

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

number

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

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

[1010,10000]

ApplicableType

string

配额调整类型。

枚举值:

  • continuous :

    连续

  • discontinuous :

    间断

discontinuous

ApplyReasonTips

string

申请配额调整理由示例。

The business xxx is expected to grow by 50%.

Consumable

boolean

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

枚举值:

  • true :

    显示“已使用”的配额

  • false :

    不显示“已使用”的配额

true

Dimensions

object

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

{"regionId":"cn-hangzhou"}

EffectiveTime

string

配额生效的 UTC 时间。

2022-09-28T06:07:00Z

ExpireTime

string

配额失效的 UTC 时间。

2022-09-29T06:07:00Z

GlobalQuota

boolean

是否为全局配额。

枚举值:

  • true :

    该配额项为所有 Region 共用

  • false :

    该配额项为每个 Region 独立

true

Period

object

配额计算周期。

PeriodUnit

string

配额计算周期的单位。

枚举值:

  • week :

  • hour :

    小时

  • day :

  • second :

  • minute :

    分钟

day

PeriodValue

integer

配额计算周期的取值。

{}

ProductCode

string

云产品名称缩写。

ecs

QuotaActionCode

string

配额 ID。

q_security-groups

QuotaArn

string

配额 ARN。

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

QuotaCategory

string

配额类型。

枚举值:

  • FlowControl :

    API 速率配额

  • WhiteListLabel :

    权益配额

  • CommonQuota :

    通用配额

CommonQuota

QuotaDescription

string

配额描述。

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

QuotaItems

array<object>

配额详情。

object

配额详情。

Quota

string

配额值。

1009

QuotaUnit

string

配额单位。

Count

Type

string

配额类别。

枚举值:

  • BaseQuota :

    保障配额

  • ReservedQuota :

    预留配额

BaseQuota

Usage

string

配额用量。

1009

QuotaName

string

配额名称。

ecs.g5.2xlarge

QuotaType

string

配额类型。

枚举值:

  • normal :

    普通

  • privilege :

    特权

privilege

QuotaUnit

string

配额单位。

AMOUNT

SupportedRange

array

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

number

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

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

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

[1009,10000]

TotalQuota

number

配额值。

200

TotalUsage

number

配额用量。

1009

UnadjustableDetail

string

配额不可调整原因。

枚举值:

  • limitReached :

    已达配额上限

  • nonactivated :

    未开通服务

  • applicationProcess :

    配额申请处理中

applicationProcess

UsageMetric

object

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

说明

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

MetricDimensions

object

CloudMonitor 监控维度。

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

string

CloudMonitor 监控维度值。

ecs

MetricName

string

CloudMonitor 监控项名称。

Usage

MetricNamespace

string

CloudMonitor 监控数据命名空间。

acs_quotas_flowcontrol

RequestId

string

请求 ID。

D0131FD5-5397-44FE-BF5A-4B7165B813CC

TotalCount

integer

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

1

示例

正常返回示例

JSON格式

{
  "MaxResults": 1,
  "NextToken": "AAAAAd****",
  "Quotas": [
    {
      "Adjustable": true,
      "ApplicableRange": [
        0
      ],
      "ApplicableType": "discontinuous",
      "ApplyReasonTips": "The business xxx is expected to grow by 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": "The maximum number of security groups that can be owned by the current account.",
      "QuotaItems": [
        {
          "Quota": "1009",
          "QuotaUnit": "Count",
          "Type": "BaseQuota",
          "Usage": "1009"
        }
      ],
      "QuotaName": "ecs.g5.2xlarge",
      "QuotaType": "privilege",
      "QuotaUnit": "AMOUNT",
      "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

错误码

错误信息

描述

400 InvalidSortOrder Invalid SortOrder 参数SortOrder无效。
400 INVALID.MAX.RESULTS The maxResults parameter is invalid. Use an integer ranging from 1 to 100. maxResults参数不合法,请使用1~100范围内的整数。
400 DIMENSIONGROUP.NOT.FOUND Dimension group does not exist. 维度组参数不正确

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

变更历史

更多信息,参考变更详情