GetProductQuota - 查询产品支持的配额详情

调用GetProductQuota接口查询目标配额详情。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

云服务名称缩写。

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

配额ID。

q_security-groups
Dimensionsarray

配额维度。

object

配额维度。

Keystring

配额维度的Key。

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

    配额维度的Value。

    说明
  • N的取值范围取决于对应云服务支持的维度个数。
    • 对于支持维度的云服务,该参数必填,且Dimensions.N.KeyDimensions.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
    TotalUsagenumber

    配额用量。

    26
    ApplicableRangearray

    配额调整范围。

    number

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

    802
    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
    TotalQuotanumber

    配额值。

    801
    ProductCodestring

    云服务名称缩写。

    ecs

    示例

    请求示例

    http(s)://[Endpoint]/?Action=GetProductQuota
    &ProductCode=ecs
    &QuotaActionCode=q_security-groups
    &Dimensions.1.Key=regionId
    &Dimensions.1.Value=cn-hangzhou
    &<公共请求参数>
    

    正常返回示例

    JSON格式

    {
      "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3",
      "Quota": {
        "QuotaDescription": "当前账户可拥有的安全组的最大数量",
        "Consumable": true,
        "ProductCode": "ecs",
        "TotalUsage": 26,
        "Dimensions": {
          "regionId": "cn-hangzhou"
        },
        "Adjustable": true,
        "QuotaActionCode": "q_security-groups",
        "QuotaName": "安全组总数量上限",
        "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/",
        "TotalQuota": 801,
        "ApplicableType": "continuous",
        "ApplicableRange": [
          802,
          10000
        ]
      }
    }

    XML格式

    <GetProductQuotaResponse>
    	<RequestId>8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3</RequestId>
    	<Quota>
    		<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>
    		<Consumable>true</Consumable>
    		<ProductCode>ecs</ProductCode>
    		<TotalUsage>26</TotalUsage>
    		<Dimensions>
    			<regionId>cn-hangzhou</regionId>
    		</Dimensions>
    		<Adjustable>true</Adjustable>
    		<QuotaActionCode>q_security-groups</QuotaActionCode>
    		<QuotaName>安全组总数量上限</QuotaName>
    		<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>
    		<TotalQuota>801</TotalQuota>
    		<ApplicableType>continuous</ApplicableType>
    		<ApplicableRange>802</ApplicableRange>
    		<ApplicableRange>10000</ApplicableRange>
    	</Quota>
    </GetProductQuotaResponse>	

    错误码

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

    阿里云首页 配额中心 相关技术圈