文档

GetProductQuota - 查询目标云产品的配额详情

更新时间:

查询目标云产品的配额详情。

接口说明

本文将提供一个示例,查询云服务器 ECS 配额q_security-groups(安全组总数量上限)的详情。返回结果显示目标配额的名称为安全组总数量上限、ID 为q_security-groups、描述为当前账户可拥有的安全组的最大数量、配额值为801、配额使用量为26、单位为、维度为{"regionId":"cn-hangzhou"}等信息。

调试

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

授权信息

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

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

请求参数

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

云产品的缩写名称。

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

配额 ID。

说明 关于如何获取目标云产品的配额 ID,请参见 ListProductQuotas 中的QuotaActionCode
q_security-groups
Dimensionsarray<object>

配额维度。 配额项的属性,维度(Dimensions)+配额 ID(QuotaActionCode)确定唯一的配额项。

说明 部分云产品维度必填。云产品的配额是什么,以及配额是否必填可以从 ListProductQuotaDimensions 获取,返回参数Requisite表示该维度是否必填。
{\"regionId\":\"cn-beijing\"}
object

配额维度。

Keystring

配额维度的 Key。

说明 Dimensions.N.KeyDimensions.N.Value必须同时设置。N 的取值范围取决于对应云产品支持的维度个数。您可以通过 ListProductQuotaDimensions 查询云产品支持的配额维度,返回数组长度就是 N。
regionId
Valuestring

配额维度的 Value。

说明 Dimensions.N.KeyDimensions.N.Value必须同时设置。N 的取值范围取决于对应云产品支持的维度个数。您可以通过 ListProductQuotaDimensions 查询云产品支持的配额维度,返回数组长度就是 N。
cn-hangzhou

返回参数

名称类型描述示例值
object

返回结果。

Quotaobject

配额详情。

Adjustableboolean

配额是否可调整。取值:

  • true:可调整。

  • false:不可调整。

true
ApplicableRangearray

配额调整范围。

ApplicableRangefloat

配额调整范围。例如:[802,10000]

802
ApplicableTypestring

配额调整类型。取值:

  • continuous:连续。

  • discontinuous:间断。

continuous
ApplyReasonTipsstring

申请配额调整理由示例。

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

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

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

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

true
Dimensionsobject

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

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

配额生效的 UTC 时间。

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

配额失效的 UTC 时间。

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

是否为全局配额。取值:

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

配额周期。

PeriodUnitstring

配额周期的单位。取值:

  • second:秒。

  • minute:分钟。

  • hour:小时。

  • day:天。

  • week:周。

day
PeriodValueinteger

配额周期的取值。

1
ProductCodestring

云产品名称缩写。

ecs
QuotaActionCodestring

配额 ID。

q_security-groups
QuotaArnstring

配额 ARN。

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

配额种类。取值:

  • CommonQuota:通用配额。

  • FlowControl:API 速率配额。

  • WhiteListLabel:权益配额。

CommonQuota
QuotaDescriptionstring

配额描述。

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

配额详情。

QuotaItemsobject

配额类别。

Quotastring

配额值。

801
QuotaUnitstring

配额单位。

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

配额类别。取值:

  • BaseQuota:保障配额。

  • ReservedQuota:预留配额。

BaseQuota
Usagestring

配额用量。

26
QuotaNamestring

配额名称。

安全组总数量上限
QuotaTypestring

配额类型。取值:

  • privilege:特权。

  • normal:普通。

normal
QuotaUnitstring

配额单位。

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

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

SupportedRangefloat

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

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

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

[802,1000]
TotalQuotafloat

配额值。

801
TotalUsagefloat

配额用量。

26
UnadjustableDetailstring

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

  • nonactivated:未开通服务。

  • applicationProcess:配额申请处理中。

  • limitReached:已达配额上限。

  • supportTicketRequired:需要提工单申请。

limitReached
UsageMetricobject

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

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

CloudMonitor 监控维度。

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

string

CloudMonitor 监控维度值。

ecs
MetricNamestring

CloudMonitor 监控项名称。

Usage
MetricNamespacestring

CloudMonitor 监控数据命名空间。

acs_quotas_flowcontrol
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "Quota": {
    "Adjustable": true,
    "ApplicableRange": [
      802
    ],
    "ApplicableType": "continuous",
    "ApplyReasonTips": "申请业务:xxx\n业务规模预计增长:50%",
    "Consumable": true,
    "Dimensions": {
      "regionId": "cn-hangzhou"
    },
    "EffectiveTime": "2022-09-28T06:06:00Z",
    "ExpireTime": "2022-09-29T06:06:00Z",
    "GlobalQuota": true,
    "Period": {
      "PeriodUnit": "day",
      "PeriodValue": 1
    },
    "ProductCode": "ecs",
    "QuotaActionCode": "q_security-groups",
    "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/",
    "QuotaCategory": "CommonQuota",
    "QuotaDescription": "当前账户可拥有的安全组的最大数量",
    "QuotaItems": [
      {
        "Quota": "801",
        "QuotaUnit": "个",
        "Type": "BaseQuota",
        "Usage": "26"
      }
    ],
    "QuotaName": "安全组总数量上限",
    "QuotaType": "normal",
    "QuotaUnit": "个",
    "SupportedRange": [
      0
    ],
    "TotalQuota": 801,
    "TotalUsage": 26,
    "UnadjustableDetail": "limitReached",
    "UsageMetric": {
      "MetricDimensions": {
        "key": "ecs"
      },
      "MetricName": "Usage",
      "MetricNamespace": "acs_quotas_flowcontrol"
    }
  },
  "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-07OpenAPI 返回结构发生变更查看变更详情
2023-06-28OpenAPI 返回结构发生变更查看变更详情
2023-03-17API 内部配置变更,不影响调用查看变更详情