调用DescribeCapacityReservations查询一个或多个容量预定服务的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCapacityReservations

系统规定参数。取值:DescribeCapacityReservations

RegionId String cn-hangzhou

容量预定服务所属地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ResourceGroupId String rg-bp67acfmxazb4p****

资源组ID。

Tag.N.Key String TestKey

标签键。N表示可以设置多个标签键进行过滤,N的取值范围:1~20。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。

Tag.N.Value String TestValue

标签键。N表示可以设置多个标签键进行过滤,N的取值范围:1~20。

MaxResults Integer 10

分页查询时每页行数。

最大值:100

默认值:10

NextToken String caeba0bbb2be03f84eb48b699f0a4883

容量预定服务查询起始标志。由上一次的请求结果中获取。

PrivatePoolOptions.Ids String ["crp-bp67acfmxazb4****", "crp-bp67acfmxazb5****"]

容量预定服务ID列表。取值可以由多个ID组成一个JSON数组,最多支持100个ID,ID之间用半角逗号(,)隔开。

Platform String linux

实例的操作系统。取值范围:

  • windows:仅查询Windows系统的容量预定服务。
  • linux:仅查Linux系统的容量预定服务。
  • all:查询所有容量预定服务。

默认值:all

InstanceType String ecs.c6.large

实例规格。

ZoneId String cn-hangzhou-h

容量预定服务所属地域下的可用区ID。

InstanceChargeType String PostPaid

实例的计费方式。取值:PostPaid,目前仅支持按量付费。

默认值:PostPaid

Status String Active

容量预定服务的状态。取值范围:

  • Preparing:准备中。
  • Active:生效中。
  • Released:已释放,包括手动释放与到期自动释放。

默认值:Active

返回数据

名称 类型 示例值 描述
CapacityReservationSet Array of CapacityReservationItem

容量预定服务详细信息组成的集合。

CapacityReservationItem
AllocatedResources Array of AllocatedResource

资源分配详情。

AllocatedResource
InstanceType String ecs.c6.large

实例规格。

TotalAmount Integer 2

在一个实例规格内,需要预留的实例的总数量。

UsedAmount Integer 2

已使用的实例的数量。

zoneId String cn-hangzhou-h

可用区ID。

Description String This is description.

容量预定服务描述。

EndTime String 2021-02-19T03:02Z

容量预定服务的失效时间。

EndTimeType String Unlimited

容量预定服务的失效方式。可能值:

  • Limited:指定时间释放。
  • Unlimited:手动释放。不限制时间。
InstanceChargeType String PostPaid

容量预定服务中实例的付费类型。

Platform String linux

匹配的实例的操作系统。可能值:

  • windows
  • linux
PrivatePoolOptionsId String crp-bp11pp9wynwtu6st****

容量预定服务ID。

PrivatePoolOptionsMatchCriteria String Open

容量预定服务生效后生成的私有资源池的类型。可能值:

  • Open:开放模式。
  • Target:专用模式。
PrivatePoolOptionsName String crpTestName

容量预定服务名称。

RegionId String cn-hangzhou

容量预定服务所属地域ID。

ResourceGroupId String rg-bp67acfmxazb4p****

容量预定服务所属的资源组ID。

StartTime String 2021-02-19T02:01Z

容量预定服务生效时间。

Status String Active

容量预定服务的状态。可能值:

  • Preparing:准备中。
  • Active:生效中。
  • Released:已释放,包括手动释放与到期自动释放。
Tags Array of Tag

容量预定服务绑定的标签键值对信息。

Tag
TagKey String TestKey

标签键。

TagValue String TestValue

标签值。

TimeSlot String null
说明 该参数正在邀测中,暂未开放使用。
MaxResults Integer 10

容量预定服务每页显示行数。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

容量预定服务下一个查询起始标志。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 1

符合查询条件的记录条数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeCapacityReservations
&RegionId=cn-hangzhou
&PrivatePoolOptions.Ids=["crp-bp67acfmxazb4****", "crp-bp67acfmxazb5****"]
&InstanceType=ecs.c6.large
&<公共请求参数>

正常返回示例

XML格式

<DescribeCapacityReservationsResponse>
      <TotalCount>1</TotalCount>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <MaxResults>10</MaxResults>
      <CapacityReservationSet>
            <CapacityReservationItem>
                  <Status>Active</Status>
                  <Description>This is description.</Description>
                  <EndTime>2021-02-19T03:02Z</EndTime>
                  <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
                  <Platform>linux</Platform>
                  <PrivatePoolOptionsName>crpTestName</PrivatePoolOptionsName>
                  <InstanceChargeType>PostPaid</InstanceChargeType>
                  <StartTime>2021-02-19T02:01Z</StartTime>
                  <PrivatePoolOptionsMatchCriteria>Open</PrivatePoolOptionsMatchCriteria>
                  <TimeSlot></TimeSlot>
                  <AllocatedResources>
                        <AllocatedResource>
                              <UsedAmount>2</UsedAmount>
                              <zoneId>cn-hangzhou-h</zoneId>
                              <TotalAmount>2</TotalAmount>
                              <InstanceType>ecs.c6.large</InstanceType>
                        </AllocatedResource>
                  </AllocatedResources>
                  <PrivatePoolOptionsId>crp-bp11pp9wynwtu6st****</PrivatePoolOptionsId>
                  <EndTimeType>Unlimited</EndTimeType>
                  <RegionId>cn-hangzhou</RegionId>
                  <Tags>
                        <Tag>
                              <TagKey>TestKey</TagKey>
                              <TagValue>TestValue</TagValue>
                        </Tag>
                  </Tags>
            </CapacityReservationItem>
      </CapacityReservationSet>
</DescribeCapacityReservationsResponse>

JSON格式

{
    "TotalCount": 1,
    "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "MaxResults": 10,
    "CapacityReservationSet": {
        "CapacityReservationItem": [
            {
                "Status": "Active",
                "Description": "This is description.",
                "EndTime": "2021-02-19T03:02Z",
                "ResourceGroupId": "rg-bp67acfmxazb4p****",
                "Platform": "linux",
                "PrivatePoolOptionsName": "crpTestName",
                "InstanceChargeType": "PostPaid",
                "StartTime": "2021-02-19T02:01Z",
                "PrivatePoolOptionsMatchCriteria": "Open",
                "TimeSlot": "",
                "AllocatedResources": {
                    "AllocatedResource": [
                        {
                            "UsedAmount": 2,
                            "zoneId": "cn-hangzhou-h",
                            "TotalAmount": 2,
                            "InstanceType": "ecs.c6.large"
                        }
                    ]
                },
                "PrivatePoolOptionsId": "crp-bp11pp9wynwtu6st****",
                "EndTimeType": "Unlimited",
                "RegionId": "cn-hangzhou",
                "Tags": {
                    "Tag": [
                        {
                            "TagKey": "TestKey",
                            "TagValue": "TestValue"
                        }
                    ]
                }
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter.RegionId The specified RegionId should not be null. RegionId是必选参数。
400 InvalidParameter.RegionId The specified RegionId is not exist. 传入的RegionId 不存在
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误,请重试。如果多次尝试失败,请提交工单。

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