You need to enable JavaScript to run this app.
导航
DescribeReservedInstances - 查询预留实例券列表
最近更新时间:2024.05.21 10:23:57首次发布时间:2023.11.21 10:21:45

调用 DescribeReservedInstances 接口获取预留实例券信息。

请求说明

调用该接口时,使用TagFilters.N.KeyTagFilters.N.Values.N查询到的预留实例券数量不能超过1000个。若超过1000个,请使用DesribeTags接口进行查询。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeReservedInstances

要执行的操作,取值:DescribeReservedInstances。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

HpcClusterId
String

hpcCluster-1

高性能计算集群ID。

InstanceTypeFamilies.N
Array of String

InstanceTypeFamilies.1=ecs.g3i

根据规格族过滤预留实例券,最多支持100个。

  • 参数 -N:表示规格族的序号。
  • 多个规格族之间用&分隔。
InstanceTypeIds.N
Array of String

InstanceTypeIds.1=ecs.g3i.2xlarge

根据规格过滤实例券,最多支持100个。

  • 参数 -N:表示规格的序号。
  • 多个规格之间用&分隔。
MaxResults
Integer

20

分页查询时设置的每页行数。

  • 最大值:100
  • 默认值:10
NextToken
String

--

分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。

ProjectName
String

project_a

资源所属项目,一个资源只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
  • 长度限制在64个字符以内。
ReservedInstanceIds.N
Array of String

ReservedInstanceIds.1=ecsri-ycsimi9g465pkfxc****

预留实例券ID,最多支持100个。

  • 参数 -N:表示预留实例券的序号。
  • 多个ID之间用&分隔。
ReservedInstanceName
String

reserved-instance-test

预留实例券的名称,支持模糊搜索。

Scope
String

ZonalRI

预留实例券的类型,取值:

  • ZonalRI(默认):可用区级预留实例券。
  • RegionalRI:地域级预留实例券。地域级预留实例券正在邀测中,如需试用,请联系客户经理申请。
Status
String

CREATING

预留实例券的状态,取值:

  • CREATING:创建中
  • ACTIVE:生效中
  • EXPIRED:已过期
  • UPDATING:更改中(指正在更改预留实例券的属性)
SupportModify
String

SizeSupport

预留实例券支持的更改类型,取值:

  • NotSupport:不支持任何更改。
  • SizeSupport:支持更改规格不支持更改可用区。
TagFilters.N.Key
Array of String

TagFilters.1.Key=k1

用户标签的标签键。

  • 参数 - N:表示标签键的序号,取值范围:1~10。
  • 多个标签键之间用&分隔,不允许重复。
TagFilters.N.Values.N
Array of String

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

用户标签的标签值。

  • 第一个N:表示标签键的序号,取值范围:1~10。
  • 第二个N:表示标签值的序号,取值范围:1~3,即同一标签键最多支持同时查询3个标签值。
  • 多个标签值之间用&分隔。

说明

  • 如果传入该参数,则必须先传入TagFilters.N.Key
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时,表示查询标签值为空的标签。
ZoneId
String

cn-beijing-a

预留实例券所在可用区ID。
您可以调用 DescribeZones 查询一个地域下的可用区信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
NextToken
String

eWNsYTg0b2s1Y3Yyd3Jzb2do****

本次调用返回的查询凭证值,返回为空表示该页为末页。

ReservedInstances
Array of ReservedInstancesForDescribeReservedInstances

--

符合条件的预留实例券信息。

请求示例

GET /?Action=DescribeReservedInstances&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202311201528596749BD5A57E146F0****",
        "Action": "DescribeReservedInstances",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "ReservedInstances": [
            {
                "CreatedAt": "2023-06-28T18:29:38+08:00",
                "ExpiredAt": "2023-07-28T18:29:38+08:00",
                "InstanceCount": 10,
                "InstanceTypeId": "ecs.g3i.xlarge",
                "ReservedInstanceId": "ecsri-ycsimi9g465pkfxc****",
                "ReservedInstanceName": "reserved-instance-test",
                "Status": "ACTIVE",
                "ZoneId": "cn-beijing-a",
                "SupportModify": "SizeSupport",
                "OfferingType": "AllUpfront",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    }
                ],
                "HpcClusterId": "",
                "ProjectName": "default",
                "Scope": "ZonalRI",
                "RegionId": "cn-beijing-a",
                "StartAt": "2023-06-28T18:29:38+08:00"
            }
        ],
        "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidTagFilterKey.Malformed
The specified TagFilterKey is malformed.

指定的查询标签的键格式错误。

400
InvalidTagFilterValue.Malformed
The specified TagFilterValue is malformed.

指定的查询标签的值格式错误。

400
LimitExceeded.MaximumInstanceTypeFamilies
You've reached the limit on the number of InstanceTypeFamilies that you can set.

指定的InstanceTypeFamilies数量超过最大限制。

400
LimitExceeded.MaximumInstanceTypeIds
You've reached the limit on the number of InstanceTypeIds that you can set.

指定的InstanceTypeIds数量超过最大限制。

400
LimitExceeded.MaximumMaxResults
The number of specified MaxResults exceeds the maximum limit.

指定的MaxResults超过最大限制。

400
LimitExceeded.MaximumReservedInstanceIds
The number of specified ReservedInstanceIds exceeds the maximum limit.

指定的ReservedInstanceIds超过最大限制。

400
LimitExceeded.MaximumTagFilterKeys
You've reached the limit on the number of TagFilterKeys that you can set.

指定的查询标签键超出取值范围。

400
LimitExceeded.MaximumTagFilterResults
You've reached the limit on the number of resources that you can describe by TagFilters.

通过标签过滤出的资源数量超过上限。

400
LimitExceeded.MaximumTagFilterValues
You've reached the limit on the number of TagFilterValues that you can set.

指定的查询标签值超出取值范围。

400
LimitExceeded.MinimumMaxResults
The number of specified MaxResults exceeds the minimum limit.

指定的MaxResults超过最小限制。

409
InvalidTagFilterKey.Conflict
The specified TagFilterKey already exists.

指定的过滤标签键已存在。

500
InternalError
An internal error has occurred.

内部错误,请重试。如果多次尝试失败,请提交工单。