首页 配额中心 API参考 API目录 产品配额 GetProductQuota - 查询产品支持的配额详情

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:GetProductQuotaRead
    全部资源
    无
无

请求参数

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

云服务名称缩写。

说明关于支持配额中心的云服务，请参见支持配额中心的云服务。
枚举值：
  • ecs：ecs。
  • entconsole：entconsole。
  • eip：eip。
  • ecs-spec：ecs-spec。
ecs
QuotaActionCodestring是

配额ID。

q_security-groups
Dimensionsarray否

配额维度。

object否

配额维度。

Keystring否

配额维度的Key。

说明
  • N的取值范围取决于对应云服务支持的维度个数。
    • 对于支持维度的云服务，该参数必填，且Dimensions.N.Key和Dimensions.N.Value必须同时设置。支持维度的云服务包括：ecs（云服务器ECS）、edas（企业级分布式应用服务）、ecs-spec（云服务器ECS规格配额）和ess（弹性伸缩）等。
    		regionId
    Valuestring否

    配额维度的Value。

    说明
  • N的取值范围取决于对应云服务支持的维度个数。
    • 对于支持维度的云服务，该参数必填，且Dimensions.N.Key和Dimensions.N.Value必须同时设置。支持维度的云服务包括：ecs（云服务器ECS）、edas（企业级分布式应用服务）、ecs-spec（云服务器ECS规格配额）和ess（弹性伸缩）等。
    		cn-hangzhou

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

    返回参数

    名称类型描述示例值
    object

    无。

    RequestIdstring

    请求ID。

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

    配额详情。

    QuotaUnitstring

    配额单位。

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

    配额ID。

    		q_security-groups
    TotalUsagefloat

    配额用量。

    		26
    ApplicableRangearray

    配额调整范围。

    float

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

    		802
    SupportedRangearray

    无

    float

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

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

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

    		[802,1000]
    QuotaTypestring

    配额类型。取值：

    • privilege：特权。

    • normal（默认值）：普通。

    		normal
    QuotaDescriptionstring

    配额描述。

    		当前账户可拥有的安全组的最大数量
    Periodobject

    配额周期。

    PeriodValueinteger

    配额周期的取值。

    		1
    PeriodUnitstring

    配额周期的单位。取值：

    • second：秒。

    • minute：分钟。

    • hour：小时。

    • day：天。

    • week：周。

    		Day
    QuotaArnstring

    配额ARN。

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

    配额调整类型。取值：

    • continuous：连续。

    • discontinuous：间断。

    		continuous
    QuotaItemsarray

    配额详情。

    object

    配额类别。

    Typestring

    配额类别。取值：

    • BaseQuota：保障配额。

    • ReservedQuota：预留配额。

    		BaseQuota
    Quotastring

    配额值。

    		801
    QuotaUnitstring

    配额单位。

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

    配额用量。

    		26
    Dimensionsobject

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

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

    配额是否可调整。取值：

    • true

    • false

    		true
    QuotaNamestring

    配额名称。

    		安全组总数量上限
    UnadjustableDetailstring

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

    • nonactivated：未开通服务。

    • applicationProcess：配额申请处理中。

    • limitReached：已达配额上限。

    • supportTicketRequired：需要提工单申请。

    		limitReached
    Consumableboolean

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

    • true

    • false

    		true
    TotalQuotafloat

    配额值。

    		801
    ProductCodestring

    云服务名称缩写。

    		ecs
    EffectiveTimestring

    配额生效的UTC时间。

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

    配额失效的UTC时间。

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

    配额种类。取值：

    • CommonQuota：通用配额。

    • FlowControl：API速率配额。

    • WhiteListLabel：权益配额。

    		CommonQuota

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3",
  "Quota": {
    "QuotaUnit": "个",
    "QuotaActionCode": "q_security-groups",
    "TotalUsage": 26,
    "ApplicableRange": [
      802
    ],
    "SupportedRange": [
      0
    ],
    "QuotaType": "normal",
    "QuotaDescription": "当前账户可拥有的安全组的最大数量",
    "Period": {
      "PeriodValue": 1,
      "PeriodUnit": "Day"
    },
    "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/",
    "ApplicableType": "continuous",
    "QuotaItems": [
      {
        "Type": "BaseQuota",
        "Quota": "801",
        "QuotaUnit": "个",
        "Usage": "26"
      }
    ],
    "Dimensions": {
      "test": "test",
      "test2": 1
    },
    "Adjustable": true,
    "QuotaName": "安全组总数量上限",
    "UnadjustableDetail": "limitReached",
    "Consumable": true,
    "TotalQuota": 801,
    "ProductCode": "ecs",
    "EffectiveTime": "2022-09-28T06:06:00Z",
    "ExpireTime": "2022-09-29T06:06:00Z",
    "QuotaCategory": "CommonQuota"
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-17API 内部配置变更，不影响调用
    变更项变更内容
    API 内部配置变更，不影响调用
    阿里云首页 配额中心 相关技术圈