ListProductQuotas - 查询产品配额列表

调用ListProductQuotas接口查询目标云服务的配额列表。

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

用来标记开始查询数据的位置。置空表示从头开始。

1
MaxResultsinteger

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

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

30
ProductCodestring

云服务名称缩写。

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

配额ID。

ecs.g5.2xlarge
KeyWordstring

配额的搜索关键字。

ecs-spec
SortFieldstring

云服务ECS规格配额支持设置排序字段。取值:

  • TIME:按最近更新时间排序。
  • TOTAL:按总配额用量排序。
  • RESERVED:按预留配额用量排序。
TIME
SortOrderstring

云服务ECS规格配额支持的排序。取值:

  • Ascending:升序。
  • Descending:降序。
Ascending
Dimensionsarray

配额维度。

object

配额维度。

Keystring

配额维度的Key。

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

配额维度的Value。

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

配额种类。取值:

  • FlowControl:API速率配额。

  • CommonQuota:通用配额。

FlowControl
GroupCodestring

维度组代码。

entconsole_w1j3msbo2g

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

返回参数

名称类型描述示例值
object

无。

TotalCountinteger

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

4
NextTokenstring

用来标记返回查询数据的位置。空表示数据已经查询完毕。

AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX
RequestIdstring

请求ID。

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

配额详情。

object

无。

QuotaUnitstring

配额单位。

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

配额ID。

ecs.g5.2xlarge
TotalUsagenumber

配额用量。

1
ApplicableRangearray

无。

number

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

802
QuotaTypestring

配额类型。取值:

  • privilege:特权。

  • normal(默认值):普通。

privilege
QuotaDescriptionstring

配额描述。

ecs.g5.2xlarge
Periodobject

配额计算周期。

PeriodValueinteger

配额计算周期的取值。

1
PeriodUnitstring

配额计算周期的单位。取值:

  • second:秒。

  • minute:分钟。

  • hour:小时。

  • day:天。

  • week:周。

day
QuotaArnstring

配额ARN。

acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i
ApplicableTypestring

配额调整类型。取值:

  • continuous:连续。

  • discontinuous:间断。

discontinuous
QuotaItemsarray

配额详情。

object

无。

Typestring

配额类别。取值:

  • BaseQuota:保障配额。

  • ReservedQuota:预留配额。

BaseQuota
Quotastring

配额值。

10
QuotaUnitstring

配额单位。

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

配额用量。

1
Dimensionsobject

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

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

配额是否可调整。取值:

  • true:配额可调整。

  • false:配额不可调整。

true
QuotaNamestring

配额名称。

ecs.g5.2xlarge
UnadjustableDetailstring

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

  • nonactivated:未开通服务。

  • applicationProcess:配额申请处理中。

  • limitReached:已达配额上限。

applicationProcess
Consumableboolean

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

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

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

true
TotalQuotanumber

配额值。

200
ProductCodestring

云服务名称缩写。

ecs-spec
MaxResultsinteger

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

1

示例

请求示例

http(s)://[Endpoint]/?Action=ListProductQuotas
&ProductCode=ecs-spec
&<公共请求参数>

正常返回示例

JSON格式

{
	"ListProductQuotasResponse": {
		"TotalCount": 4,
		"RequestId": "F3A3568B-B01E-4EA7-B3DD-0699B4D319F9",
		"NextToken": "AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX",
		"Quotas": {
			"QuotaDescription": "ecs.g5.2xlarge",
			"Consumable": true,
			"TotalUsage": 3,
			"ProductCode": "ecs-spec",
			"Dimensions": {
				"regionId": "cn-hangzhou",
				"chargeType": "PostPaid",
				"zoneId": "cn-hangzhou-i",
				"networkType": "vpc",
				"resourceType": "InstanceType"
			},
			"QuotaUnit": "AMOUNT",
			"Period": "",
			"Adjustable": true,
			"QuotaActionCode": "ecs.g5.2xlarge",
			"QuotaName": "ecs.g5.2xlarge",
			"QuotaItems": [{
					"Usage": 0,
					"Type": "ReservedQuota",
					"Quota": 0
				},
				{
					"Usage": 0,
					"Type": "BaseQuota",
					"Quota": 0
				}
			],
			"QuotaArn": "acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i",
			"TotalQuota": 160,
			"ApplicableType": "continuous"
		},
		"MaxResults": 1
	}
}

XML格式

<ListProductQuotasResponse>
    <TotalCount>4</TotalCount>
    <RequestId>F3A3568B-B01E-4EA7-B3DD-0699B4D319F9</RequestId>
    <NextToken>AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX</NextToken>
    <Quotas>
        <QuotaDescription>ecs.g5.2xlarge</QuotaDescription>
        <Consumable>true</Consumable>
        <TotalUsage>3</TotalUsage>
        <ProductCode>ecs-spec</ProductCode>
        <Dimensions>
            <regionId>cn-hangzhou</regionId>
            <chargeType>PostPaid</chargeType>
            <zoneId>cn-hangzhou-i</zoneId>
            <networkType>vpc</networkType>
            <resourceType>InstanceType</resourceType>
        </Dimensions>
        <QuotaUnit>AMOUNT</QuotaUnit>
        <Period/>
        <Adjustable>true</Adjustable>
        <QuotaActionCode>ecs.g5.2xlarge</QuotaActionCode>
        <QuotaName>ecs.g5.2xlarge</QuotaName>
        <QuotaItems>
            <Usage>0</Usage>
            <Type>ReservedQuota</Type>
            <Quota>0</Quota>
        </QuotaItems>
        <QuotaItems>
            <Usage>0</Usage>
            <Type>BaseQuota</Type>
            <Quota>0</Quota>
        </QuotaItems>
        <QuotaArn>acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i</QuotaArn>
        <TotalQuota>160</TotalQuota>
        <ApplicableType>continuous</ApplicableType>
    </Quotas>
    <MaxResults>1</MaxResults>
</ListProductQuotasResponse>

错误码

Http code错误码错误信息描述
400InvalidSortOrderInvalid SortOrder参数 SortOrder 无效
400INVALID.MAX.RESULTSThe maxResults parameter is invalid. Use an integer ranging from 1 to 100.maxResults参数不合法,请使用1~100范围内的整数。

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

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