本接口主要用于查詢指定地域下您已經(jīng)購(gòu)買(mǎi)的預(yù)留實(shí)例券信息列表，支持您根據(jù)標(biāo)簽、預(yù)留實(shí)例券屬性等參數(shù)獲取預(yù)留實(shí)例券詳細(xì)信息列表。
接口說(shuō)明
適用場(chǎng)景
- 查詢指定地域下所有的預(yù)留實(shí)例券。
- 根據(jù)預(yù)留實(shí)例券 ID 或名稱查詢其詳細(xì)信息。
- 根據(jù)實(shí)例規(guī)格或者實(shí)例規(guī)格族過(guò)濾查詢您已購(gòu)買(mǎi)的預(yù)留實(shí)例券。
- 根據(jù)預(yù)留實(shí)例券范圍或者狀態(tài)過(guò)濾查詢您已購(gòu)買(mǎi)的預(yù)留實(shí)例券。
請(qǐng)求示例
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeReservedInstances | get | *ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/**ReservedInstance acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#reservedinstanceId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 預(yù)留實(shí)例券所屬的地域 ID。您可以調(diào)用 DescribeRegions 獲取最新的阿里云地域列表。 | cn-hangzhou |
| PageNumber | integer | 否 | 預(yù)留實(shí)例券列表的頁(yè)碼，起始值：1。 默認(rèn)值：1。 | 1 |
| PageSize | integer | 否 | 分頁(yè)查詢時(shí)的每頁(yè)行數(shù)，最大值：100。 默認(rèn)值：10。 | 50 |
| Tag | array<object> | 否 | 標(biāo)簽數(shù)組。數(shù)組長(zhǎng)度：1~20。 | |
| object | 否 | 標(biāo)簽。 | ||
| Key | string | 否 | 預(yù)留實(shí)例券的標(biāo)簽鍵。不允許為空字符串，最多支持 128 個(gè)字符，不能以 aliyun 和 acs:開(kāi)頭，不能包含 http://或者 https://。 說(shuō)明
使用一個(gè)標(biāo)簽過(guò)濾資源，查詢到該標(biāo)簽下的資源數(shù)量不能超過(guò) 1000 個(gè)；使用多個(gè)標(biāo)簽過(guò)濾資源，查詢到同時(shí)綁定了多個(gè)標(biāo)簽的資源數(shù)量不能超過(guò) 1000 個(gè)；如果資源數(shù)量超過(guò) 1000 個(gè)，請(qǐng)使用 ListTagResources 接口進(jìn)行查詢。
| TestKey |
| Value | string | 否 | 預(yù)留實(shí)例券的標(biāo)簽值。不允許為空字符串,最多支持 128 個(gè)字符，不能以 | TestValue |
| ZoneId | string | 否 | 實(shí)例所屬的可用區(qū)編號(hào)，當(dāng) Scope 為 Zone 時(shí)生效并且必填。您可以通過(guò) DescribeZones 獲取可用區(qū)列表。 | cn-hangzhou-z |
| ReservedInstanceName | string | 否 | 預(yù)留實(shí)例券名稱。 說(shuō)明
完全匹配，暫不支持模糊查詢過(guò)濾。
| testReservedInstanceName |
| LockReason | string | 否 | 鎖定類型。取值范圍：
| security |
| InstanceType | string | 否 | 預(yù)留實(shí)例券對(duì)應(yīng)的實(shí)例規(guī)格。取值請(qǐng)參見(jiàn)實(shí)例規(guī)格族。 說(shuō)明
購(gòu)買(mǎi)預(yù)留實(shí)例券時(shí)選擇的實(shí)例規(guī)格，實(shí)際抵扣的時(shí)候，地域級(jí)預(yù)留實(shí)例券支持同規(guī)格組內(nèi)的不同大小規(guī)格換算抵扣。
| ecs.g5.large |
| InstanceTypeFamily | string | 否 | 預(yù)留實(shí)例券對(duì)應(yīng)的實(shí)例規(guī)格族。取值請(qǐng)參見(jiàn)實(shí)例規(guī)格族。 | ecs.g5 |
| Scope | string | 否 | 預(yù)留實(shí)例券的范圍。取值范圍：
| Region |
| OfferingType | string | 否 | 預(yù)留實(shí)例券的付款類型。取值范圍：
| All Upfront |
| AllocationType | string | 否 | 分配類型。取值范圍：
默認(rèn)值：Normal。 | Normal |
| ReservedInstanceId | array | 否 | 預(yù)留實(shí)例券 ID 數(shù)組。數(shù)組長(zhǎng)度：1~100。 | |
| string | 否 | 預(yù)留實(shí)例券 ID。 | ri-bpzhex2ulpzf53**** | |
| Status | array | 否 | 預(yù)留實(shí)例券的狀態(tài)數(shù)組。 | |
| string | 否 | 預(yù)留實(shí)例券的狀態(tài)。狀態(tài)值取值范圍：
| Active |
返回參數(shù)
示例
正常返回示例
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"
}
]
}
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingParamter.RegionId | The regionId should not be null. | 參數(shù) RegionId 不得為空。 |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 參數(shù)不合法。 |
| 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 超過(guò)限制。 |
| 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. | 指定的分配類型無(wú)效。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在，請(qǐng)您檢查此產(chǎn)品在該地域是否可用。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|