本接口主要用于查询您已经购买的预留实例券信息,支持您根据标签、预留实例券属性等参数获取预留实例券详细信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeReservedInstances | get | *ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/* *ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#reservedinstanceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
PageNumber | integer | 否 | 预留实例券列表的页码,起始值:1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时的每页行数,最大值:100。 默认值:10。 | 50 |
Tag | array<object> | 否 | 标签数组。数组长度:1~20。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 预留实例券的标签键。不允许为空字符串,最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。 说明
使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个;如果资源数量超过 1000 个,请使用 ListTagResources 接口进行查询。
| TestKey |
Value | string | 否 | 预留实例券的标签值。不允许为空字符串,最多支持 128 个字符,不能以 | TestValue |
ZoneId | string | 否 | 实例所属的可用区编号,当 Scope 为 Zone 时必填。更多详情,请参见 DescribeZones 获取可用区列表。 | cn-hangzhou-z |
ReservedInstanceName | string | 否 | 预留实例券名称。 | testReservedInstanceName |
LockReason | string | 否 | 锁定类型。取值范围:
| security |
InstanceType | string | 否 | 实例资源的规格。取值请参见实例规格族。 | ecs.g5.large |
InstanceTypeFamily | string | 否 | 实例资源的规格族。取值请参见实例规格族。 | ecs.g5 |
Scope | string | 否 | 预留实例券的范围。取值范围:
默认值:Region。 | Region |
OfferingType | string | 否 | 预留实例券的付款类型。取值范围:
| All Upfront |
AllocationType | string | 否 | 分配类型。取值范围:
默认值:Normal。 | Normal |
ReservedInstanceId | array | 否 | 预留实例券 ID 数组。数组长度:1~100。 | |
string | 否 | 预留实例券 ID。 | ri-bpzhex2ulpzf53**** | |
Status | array | 否 | 预留实例券的状态数组。 | |
string | 否 | 预留实例券的状态。状态值取值范围:
| Active |
返回参数
示例
正常返回示例
JSON
格式
{
"PageSize": 1,
"RequestId": "E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
"PageNumber": 1,
"TotalCount": 1,
"ReservedInstances": {
"ReservedInstance": [
{
"Status": "Active",
"CreationTime": "2018-12-10T12:07Z",
"ReservedInstanceName": "riZbpzhex2ulpzf53****",
"ReservedInstanceId": "ri-bpzhex2ulpzf53****",
"InstanceType": "ecs.g5.large",
"InstanceAmount": 10,
"RegionId": "cn-hangzhou",
"OfferingType": "All Upfront",
"StartTime": "2018-12-10T12:00Z",
"Description": "testDescription",
"AllocationStatus": "allocated",
"ExpiredTime": "2019-12-10T12:07Z",
"ResourceGroupId": "EcsDocTest",
"ZoneId": "cn-hangzhou-z",
"Platform": "Linux",
"Scope": "region",
"OperationLocks": {
"OperationLock": [
{
"LockReason": "security"
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParamter.RegionId | The regionId should not be null. | 参数 RegionId 不得为空。 |
400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 参数不合法。 |
400 | InvalidZone.NotFound | The specified parameter ZoneId is not valid. | 指定的ZoneId不合法。 |
400 | InvalidReservedInstanceOfferingType.ValueNotSupported | the OfferingType is not supported | - |
400 | InvalidReservedInstanceOfferingClass.ValueNotSupported | the OfferingClass is not supported | - |
400 | OperationDenied | The specified InstanceType or Zone is not authorized for current user. | - |
400 | InvalidEndTime.ValueNotSupported | The specified endTime is out of the permitted range. | 指定的 EndTime 超过限制。 |
400 | InvalidReservedInstanceLockReason.ValueNotSupported | The specified LockReason is not supported. | - |
400 | InvalidReservedInstanceStatus.ValueNotSupported | The specified Status is not supported. | - |
400 | InvalidAllocationType.ValueNotSupported | The specified AllocationType is not supported. | 指定的分配类型无效。 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在,请您检查此产品在该地域是否可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史