指定されたリージョンで購入したリザーブドインスタンスの詳細を照会します。タグ、リザーブドインスタンスの属性、その他のパラメーターで結果をフィルター処理できます。
操作説明
シナリオ
指定されたリージョンのすべてのリザーブドインスタンスを照会します。
ID または名前でリザーブドインスタンスの詳細を照会します。
インスタンスタイプまたはインスタンスファミリーでリザーブドインスタンスをフィルター処理します。
範囲またはステータスでリザーブドインスタンスをフィルター処理します。
リクエストの例
今すぐお試しください
テスト
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> |
任意 |
タグ。配列の長さ: 1 ~ 20。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
リザーブドインスタンスのタグキー。タグキーは空文字列にできず、最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。 説明
単一のタグを使用してリソースをフィルター処理する場合、返されるリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、複数のタグがアタッチされているリソースのリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources 操作を呼び出してリソースをクエリしてください。 |
TestKey |
| Value |
string |
任意 |
リザーブドインスタンスのタグ値。タグ値は空文字列にできず、最大 128 文字です。acs: で始めることはできず、http:// または https:// を含めることはできません。 |
TestValue |
| ZoneId |
string |
任意 |
インスタンスのゾーン ID。このパラメーターは必須であり、Scope が Zone にセットされている場合にのみ効果があります。 DescribeZones 操作を呼び出して、ゾーンリストをクエリできます。 |
cn-hangzhou-z |
| ReservedInstanceName |
string |
任意 |
リザーブドインスタンスの名前。 説明
完全に一致が使用されます。あいまい一致はサポートされていません。 |
testReservedInstanceName |
| LockReason |
string |
任意 |
ロックタイプ。有効な値:
|
security |
| InstanceType |
string |
任意 |
リザーブドインスタンスに一致するインスタンスタイプ。詳細については、「Instance families」を参照してください。 説明
これは、リザーブドインスタンスの購入時に選択したインスタンスタイプです。リザーブドインスタンスが適用されると、リージョンリザーブドインスタンスは、等価計算に基づいて同じインスタンスファミリー内の異なるインスタンスタイプに適用できます。 |
ecs.g5.large |
| InstanceTypeFamily |
string |
任意 |
リザーブドインスタンスに一致するインスタンスファミリー。詳細については、「Instance families」を参照してください。 |
ecs.g5 |
| Scope |
string |
任意 |
リザーブドインスタンスの範囲。有効な値:
|
Region |
| OfferingType |
string |
任意 |
リザーブドインスタンスの支払いタイプ。有効な値:
|
All Upfront |
| AllocationType |
string |
任意 |
割り当てタイプ。有効な値:
デフォルト値: Normal。 |
Normal |
| ReservedInstanceId |
array |
任意 |
リザーブドインスタンス ID。配列の長さ: 1 ~ 100。 |
ri-bpzhex2ulpzf53**** |
|
string |
任意 |
リザーブドインスタンス ID。 |
ri-bpzhex2ulpzf53**** |
|
| Status |
array |
任意 |
リザーブドインスタンスのステータス。 |
Active |
|
string |
任意 |
リザーブドインスタンスのステータス。有効な値:
|
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 |
作成時間。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表示されます。 |
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 |
有効期間。形式は ISO 8601 で、時間ゾーンは協定世界時 (UTC) です。 |
2018-12-10T12:00Z |
| Description |
string |
説明。 |
testDescription |
| AllocationStatus |
string |
リザーブドインスタンスの割り当てステータス。このパラメーターは、AllocationType が Shared に設定されている場合にのみ返されます。有効な値:
|
allocated |
| ExpiredTime |
string |
有効期限。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表示されます。 |
2019-12-10T12:07Z |
| ResourceGroupId |
string |
リソースグループ。 |
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"
}
]
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. | 指定された割り当てタイプは無効です。 |
| 403 | RAM.ApiNotSupported | This call is not supported from ram accessing. | RAM ユーザーにこの操作を実行する権限がありません。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定された RegionId が存在しません。指定されたリージョンでこのプロダクトが利用可能かどうかを確認してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。