查询一个或多个容量预定服务的详细信息，例如服务的状态、服务的生效与失效时间、私有池的模式和已使用的实例的数量等。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeCapacityReservations | get | *CapacityReservation acs:ecs:{#regionId}:{#accountId}:capacityreservation/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 容量预定服务所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 容量预定服务绑定的标签对集合。 | |
| object | 否 | 标签对。 | ||
| Key | string | 否 | 标签键。N 表示可以设置多个标签键进行过滤，N 的取值范围为 1~20。 使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。 | TestKey |
| Value | string | 否 | 标签值。N 表示可以设置多个标签值进行过滤，N 的取值范围为 1~20。 | TestValue |
| MaxResults | integer | 否 | 分页查询时每页行数。 最大值：100。 默认值：10。 | 10 |
| NextToken | string | 否 | 容量预定服务查询起始标志。由上一次的请求结果中获取。 | caeba0bbb2be03f84eb48b699f0a4883 |
| PrivatePoolOptions.Ids | string | 否 | 容量预定服务 ID 列表。取值可以由多个 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。 | ["crp-bp1gubrkqutenqdd****", "crp-bp67acfmxazb5****"] |
| Platform | string | 否 | 实例的操作系统。取值范围：
默认值：all。 | linux |
| InstanceType | string | 否 | 实例规格。通过实例规格只可以查询还在生效中的容量预定服务，已释放的服务只能通过 PrivatePoolOptions.Ids 查询。 | ecs.c6.large |
| ZoneId | string | 否 | 容量预定服务所属的可用区 ID。 | cn-hangzhou-h |
| InstanceChargeType | string | 否 | 实例的计费方式。取值范围：
默认值：PostPaid。 | PostPaid |
| Status | string | 否 | 容量预定服务的状态。取值范围：
默认值：Active。 | Active |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"TotalCount": 1,
"MaxResults": 10,
"CapacityReservationSet": {
"CapacityReservationItem": [
{
"Status": "Active",
"TimeSlot": "null",
"PrivatePoolOptionsMatchCriteria": "Open",
"PrivatePoolOptionsId": "crp-bp1gubrkqutenqdd****",
"PrivatePoolOptionsName": "crpTestName",
"RegionId": "cn-hangzhou",
"InstanceChargeType": "PostPaid",
"EndTime": "2021-02-19T03:02Z",
"StartTime": "2021-02-19T02:01Z",
"Description": "This is description.",
"EndTimeType": "Unlimited",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Platform": "linux",
"AllocatedResources": {
"AllocatedResource": [
{
"UsedAmount": 2,
"TotalAmount": 2,
"AvailableAmount": 2,
"zoneId": "cn-hangzhou-h",
"InstanceType": "ecs.c6.large",
"CapacityReservationUsages": {
"CapacityReservationUsage": [
{
"AccountId": "105909559088****",
"ServiceName": "maxcompute.aliyuncs.com",
"UsedAmount": 20
}
]
}
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"StartTimeType": "Now",
"SavingPlanId": "spn-c29b5e18pJMT****",
"ReservedInstanceId": "ri-bpzhex2ulpzf53****",
"CapacityReservationOwnerId": "100************7\n"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter.RegionId | The specified RegionId should not be null. | RegionId是必选参数。 |
| 400 | InvalidParameter.Name | The specified PrivatePoolOptions.Name is invalid. | - |
| 400 | InvalidParameter.PrivatePoolOptions.Ids | The specified PrivatePoolOptions.Ids is invalid. | - |
| 400 | DedicatedHostNotSupported | DedicatedHost is not supported for PrivatePool. | 私有池不支持专有宿主机。 |
| 400 | SpotNotSupported | Spot is not supported for PrivatePool. | 私有池不支持抢占式实例。 |
| 400 | ClassicNetworkNotSupported | Classic network is not supported for PrivatePool. | 私有池不支持经典网络类型实例。 |
| 400 | Invalid.InstanceId | Instance does not exist. | 实例不存在。 |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | Target mode does not support this operation. | Target模式不支持本次操作。 |
| 400 | MissingParameter.PrivatePoolOptions.Id | The specified PrivatePoolOptions.Id should not be null. | PrivatePoolOptions.Id 参数不能为空。 |
| 400 | Invalid.PrivatePoolOptions.Id | The PrivatePool does not exist. | 私有池不存在。 |
| 400 | Invalid.InstanceType | The InstanceType does not match the PrivatePool. | 实例类型与私有池不匹配。 |
| 400 | Invalid.InstanceChargeType | The InstanceChargeType does not match the PrivatePool. | 实例计费类型与私有池不匹配。 |
| 400 | Invalid.ZoneId | The ZoneId does not match the PrivatePool. | 可用区与私有池不匹配。 |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool has been used up. | - |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | The PrivatePoolOptions.MatchCriteria does not match the PrivatePool. | 指定的PrivatePoolOptions.MatchCriteria参数与私有池不匹配。 |
| 400 | InvalidPlatform.ValueNotSupported | The Platform does not match the PrivatePool. | 指定的Platform参数与私有池不匹配。 |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool is expired or inactive. | - |
| 400 | Invalid.PrivatePoolOptions.status | The PrivatePool status is not valid. | - |
| 400 | Invalid.PrivatePoolOptions.status | The Instance should be created within 48 hours once the PrivatePool is started. | - |
| 400 | InvalidAliUid | The PrivatePool does not belong to the user of the Instance. | 私有池不属于创建实例的用户。 |
| 400 | Invalid.InstanceId | The Instance dose not attached to a PrivatePool. | 实例未与私有池匹配。 |
| 400 | MissingParameter.PackageType | The specified parameter "PackageType" can not be empty. | - |
| 400 | MissingParameter.PrivatePoolOptions.Ids | The specified parameter "PrivatePoolOptions.Ids" can not be empty. | - |
| 400 | MissingParameter.PrivatePoolOptions.Id | The specified parameter "PrivatePoolOptions.Id" can not be empty. | - |
| 400 | MissingParameter.InstanceCpuCoreCount | The specified parameter "InstanceCpuCoreCount" can not be empty. | - |
| 400 | MissingParameter.InstanceAmount | The specified parameter "InstanceAmount" can not be empty. | - |
| 400 | MissingParameter.InstanceCpuCoreCountOrInstanceAmount | The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time. | - |
| 400 | Invalid.TooManyPrivatePoolOptions.Ids | Too many PrivatePoolOptions.Ids in this request. | PrivatePoolOptions.Ids参数超过上限。 |
| 400 | Invalid.TooManyZoneIds | Too many ZoneIds in the request. | ZoneIds参数超过上限。 |
| 400 | Invalid.TooManyInstanceTypes | Too many InstanceTypes in the request. | InstanceTypes参数超过上限。 |
| 400 | Invalid.TooManyUnpaidPrivatePool | Too many PrivatePools create but still unpaid. | 多个私有池未支付。 |
| 400 | Invalid.InstanceCpuCoreCountOrInstanceAmount | Both InstanceCpuCoreCount and InstanceAmount are provided. | InstanceCpuCoreCount和InstanceAmount两个参数不需要同时提供。 |
| 400 | Invalid.PrivatePoolOptions.Ids | The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id. | - |
| 400 | Invalid.PackageType | The specified parameter "PackageType" is invalid. | - |
| 400 | Invalid.PrivatePool.Purchase | The PrivatePool has already paid. | 私有池已经支付。 |
| 400 | Invalid.AssuranceTimes.NotSupported | The value of AssuranceTimes is not supported. | AssuranceTimes参数值不支持。 |
| 400 | Invalid.TooManyInstanceTypes | The specified parameter "InstanceType" should only has one item. | - |
| 400 | Invalid.PrivatePoolOptions.MatchCriteria | The specified parameter "PrivatePoolOptions.MatchCriteria" is invalid. | - |
| 400 | RepeatStartPrivatePool | PrivatePool has already been started. | 私有池已经启动。 |
| 400 | Invalid.PrivatePoolOptions.Id | The specified parameter "PrivatePoolOptions.Id" should be empty. | - |
| 400 | Invalid.InstanceId | Modify DedicatedHost Instance's attachment attributes is not supported. | - |
| 400 | Invalid.InstanceId | Modify Spot Instance's attachment attributes is not supported. | - |
| 400 | Invalid.InstanceId | Modify Classic Network Instance's attachment attributes is not supported. | - |
| 400 | InvalidParameter.RegionId | The specified RegionId is not exist. | 传入的 RegionId 不存在。 |
| 400 | InvalidPermission.ResourceShareAssocoated | The current resource is associated to a shared relationship and cannot be released. | 当前资源被绑定共享关系，无法释放 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-06-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |