特定のリージョンで購入したリザーブドインスタンスの詳細を照会します。タグやリザーブドインスタンスの属性などのパラメーターに基づいて、リザーブドインスタンスの詳細を照会できます。
操作説明
利用シーン
特定のリージョン内のすべてのリザーブドインスタンスを照会します。
ID または名前に基づいてリザーブドインスタンスの詳細を照会します。
インスタンスタイプまたはインスタンスファミリーに基づいて、購入済みのリザーブドインスタンスを照会します。
リザーブドインスタンスの範囲またはステータスに基づいて、購入済みのリザーブドインスタンスを照会します。
リクエストの例
例:中国 (杭州) リージョンで購入したすべてのリザーブドインスタンスを照会する
"RegionId":"cn-hangzhou", //リージョン ID。
例:中国 (杭州) リージョンで ID が ecsri-bp129enntoynwwj5**** のリザーブドインスタンスの詳細を照会する
"RegionId":"cn-hangzhou", //リージョン ID。"ReservedInstanceId":"ecsri-bp129enntoynwwj5****" //リザーブドインスタンスの ID。
例:中国 (杭州) リージョンで ecs.c5.2xlarge インスタンスの請求を相殺するために使用できるリザーブドインスタンスを照会する
"RegionId":"cn-hangzhou", //リージョン ID。"InstanceType":"ecs.c5.2xlarge", //インスタンスタイプ。
例:中国 (杭州) リージョンで有効期間内のリージョンリザーブドインスタンスを照会する
"RegionId":"cn-hangzhou", //リージョン ID。"Scope":"Region", //リザーブドインスタンスの範囲をリージョンに設定します。"Status":["Active"] //ステータスを Active に設定します。これは、リザーブドインスタンスが有効期間内であることを示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeReservedInstances |
get |
ReservedInstance
ReservedInstance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リザーブドインスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。 デフォルト値:1。 |
1 |
| PageSize |
integer |
任意 |
ページあたりのエントリ数。有効値の範囲:1~100。 デフォルト値:10。 |
50 |
| Tag |
array<object> |
任意 |
リザーブドインスタンスのタグ。最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
リザーブドインスタンスの N 番目のタグ。 |
||
| Key |
string |
任意 |
リザーブドインスタンスの N 番目のタグのキー。タグキーは空にできず、最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 説明
単一のタグを指定してリソースを照会する場合、そのタグが追加された最大 1,000 個のリソースが返されます。複数のタグを指定してリソースを照会する場合、指定されたすべてのタグが追加された最大 1,000 個のリソースが返されます。指定されたタグが追加された 1,000 個を超えるリソースを照会するには、ListTagResources 操作を呼び出してください。 |
TestKey |
| Value |
string |
任意 |
リザーブドインスタンスの N 番目のタグの値。タグ値は空にできず、最大 128 文字です。`acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 |
TestValue |
| RegionId |
string |
必須 |
リザーブドインスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| ZoneId |
string |
任意 |
リザーブドインスタンスのゾーン ID。このパラメーターは、`Scope` を `Zone` に設定した場合に有効かつ必須です。 DescribeZones 操作を呼び出して、最新のゾーンリストを照会できます。 |
cn-hangzhou-z |
| ReservedInstanceName |
string |
任意 |
リザーブドインスタンスの名前。 説明
完全一致検索のみがサポートされています。 |
testReservedInstanceName |
| LockReason |
string |
任意 |
リザーブドインスタンスがロックされている理由。有効値:
|
security |
| InstanceType |
string |
任意 |
リザーブドインスタンスのインスタンスタイプ。有効値の詳細については、「インスタンスファミリーの概要」をご参照ください。 説明
リザーブドインスタンスの購入時に選択したインスタンスタイプを指定してください。リザーブドインスタンスがリージョンリザーブドインスタンスの場合、インスタンスの仕様に関係なく、指定されたインスタンスタイプと同じインスタンスファミリーに属するインスタンスタイプの請求を相殺するために使用できます。 |
ecs.g5.large |
| InstanceTypeFamily |
string |
任意 |
リザーブドインスタンスのインスタンスファミリー。有効値の詳細については、「インスタンスファミリーの概要」をご参照ください。 |
ecs.g5 |
| Scope |
string |
任意 |
リザーブドインスタンスの範囲レベル。有効値:
|
Region |
| OfferingType |
string |
任意 |
リザーブドインスタンスの支払い方法。有効値:
|
All Upfront |
| AllocationType |
string |
任意 |
リザーブドインスタンスの割り当てタイプ。有効値:
デフォルト値:Normal。 |
Normal |
| ReservedInstanceId |
array |
任意 |
リザーブドインスタンスの ID。最大 100 個のリザーブドインスタンス ID を指定できます。 |
ri-bpzhex2ulpzf53**** |
|
string |
任意 |
N 番目のリザーブドインスタンスの ID。 |
ri-bpzhex2ulpzf53**** |
|
| Status |
array |
任意 |
リザーブドインスタンスのステータス。 |
Active |
|
string |
任意 |
N 番目のリザーブドインスタンスのステータス。有効値:
|
Active |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
ページあたりのエントリ数。 |
1 |
| RequestId |
string |
リクエスト ID。 |
E572643C-6A29-49D6-9D4E-6CFA4E063A3E |
| PageNumber |
integer |
ページ番号。 |
1 |
| TotalCount |
integer |
リザーブドインスタンスの総数。 |
1 |
| ReservedInstances |
object |
||
| ReservedInstance |
array<object> |
リザーブドインスタンスの詳細。 |
|
|
array<object> |
リザーブドインスタンスの詳細。 |
||
| Status |
string |
ステータス。 |
Active |
| CreationTime |
string |
作成時刻。 |
2018-12-10T12:07Z |
| ReservedInstanceName |
string |
名前。 |
riZbpzhex2ulpzf53**** |
| ReservedInstanceId |
string |
リザーブドインスタンス ID。 |
ri-bpzhex2ulpzf53**** |
| InstanceType |
string |
リザーブドインスタンスに一致させることができる従量課金インスタンスのインスタンスタイプ。 |
ecs.g5.large |
| InstanceAmount |
integer |
リザーブドインスタンスと同じインスタンスタイプで、リザーブドインスタンスに一致させることができる従量課金インスタンスの数。 |
10 |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| OfferingType |
string |
支払い方法。 |
All Upfront |
| StartTime |
string |
有効開始時刻。 |
2018-12-10T12:00Z |
| Description |
string |
説明。 |
testDescription |
| AllocationStatus |
string |
`AllocationType` パラメーターが `Shared` に設定されている場合のリザーブドインスタンスの共有ステータスを示します。有効値:
|
allocated |
| ExpiredTime |
string |
有効期限。 |
2019-12-10T12:07Z |
| ResourceGroupId |
string |
リソースグループ ID。 |
EcsDocTest |
| ZoneId |
string |
ゾーン ID。 |
cn-hangzhou-z |
| Platform |
string |
インスタンスが使用するイメージのオペレーティングシステム。有効値:
|
Linux |
| Scope |
string |
範囲。 |
region |
| OperationLocks |
object |
||
| OperationLock |
array<object> |
リザーブドインスタンスのロックステータスの詳細。 |
|
|
object |
リザーブドインスタンスのロックステータスの詳細。 |
||
| LockReason |
string |
インスタンスがロックされている理由。 |
security |
| Tags |
object |
||
| Tag |
array<object> |
リザーブドインスタンスのタグ。 |
|
|
object |
リザーブドインスタンスのタグ。 |
||
| TagValue |
string |
タグ値。 |
TestValue |
| TagKey |
string |
タグキー。 |
TestKey |
例
成功レスポンス
JSONJSON
{
"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"
}
]
}
}
]
}
}
エラーレスポンス
JSONJSON
{
"code":"200",
"data":{
"data":[
{
"CreationTime":"2018-12-10T12:07Z",
"ExpiredTime":"2019-12-10T16:00Z",
"InstanceAmount":1,
"ReservedInstanceId":"ri-0xzhex2ulpzf53rxme2j",
"InstanceType":"ecs.g5.large",
"OfferingType":"All Upfront",
"RegionId":"cn-hangzhou-test-307",
"ReservedInstanceName":"riZ0xzhex2ulpzf53rxme2jZ",
"Scope":"region",
"StartTime":"2018-12-10T12:00Z",
"Status":"active"
}
],
"PageNumber":1,
"PageSize":50,
"Total":1
},
"httpStatusCode":200,
"message":"successful",
"requestId":"E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
"success":true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | MissingParamter.RegionId | The regionId should not be null. | |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | |
| 400 | InvalidZone.NotFound | The specified parameter ZoneId is not valid. | |
| 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. | |
| 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. | |
| 403 | RAM.ApiNotSupported | This call is not supported from ram accessing. | |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。