インスタンスをクエリします。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/openapi/listinstances HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Status |
string |
任意 |
インスタンスのステータス。 列挙値:
|
normal |
| MaxResults |
integer |
任意 |
返されるインスタンスの最大数。有効値：0～200。このパラメーターを設定しないか、0 に設定した場合、デフォルト値の 100 が使用されます。 |
100 |
| NextToken |
string |
任意 |
クエリの開始位置を決定するトークン。このパラメーターを、最後の呼び出しから返された NextToken パラメーターの値に設定します。インスタンスは、このパラメーターで指定された位置から辞書順で返されます。初めて操作を呼び出すときは、このパラメーターを空のままにします。 |
CAESCG15aC1xxxxx |
| InstanceName |
string |
任意 |
インスタンスの名前。あいまい検索がサポートされています。 |
instance |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。ID は Resource Management コンソールの [リソースグループ] ページで照会できます。 |
rg-aek24upgom6p5ri |
| InstanceNameList |
array |
任意 |
インスタンスの名前。このパラメーターは、同時にクエリする複数のインスタンスを指定するために使用されます。 |
|
|
string |
任意 |
インスタンスの名前。完全一致がサポートされています。 |
instance-test |
|
| Tag |
array<object> |
任意 |
インスタンスのタグ。 |
|
|
object |
任意 |
インスタンスのタグ。 |
||
| Key |
string |
任意 |
タグキー。 |
Owner |
| Value |
string |
任意 |
タグ値。 |
Tester |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返された構造体。 |
||
| RequestId |
string |
リクエスト ID。問題のトラブルシューティングに使用できます。 |
E734979F-5A44-5993-9CE5-C23103576923 |
| TotalCount |
integer |
返されたインスタンスの総数。 |
2 |
| NextToken |
string |
次のクエリの開始位置を決定するトークン。このパラメーターが空の場合、クエリするすべてのインスタンスが返されます。 |
CAESCG15aC1xxxxx |
| Instances |
array<object> |
インスタンスの詳細。 |
|
|
object |
インスタンス。 |
||
| InstanceName |
string |
インスタンスを一意に識別するために使用されるインスタンスの名前。 |
instance-test |
| ResourceGroupId |
string |
リソースグループの ID。 |
rg-acfmxh4em5jnbcd |
| RegionId |
string |
リージョン ID。 |
cn-huhehaote |
| SPInstanceId |
string |
インスタンス ID。 |
ots_standard_public_cn-g4t3igqjj002 |
| AliasName |
string |
インスタンスのエイリアス。 |
instance-test |
| UserId |
string |
ユーザー ID。 |
13542356466 |
| InstanceDescription |
string |
インスタンスの説明。 |
Description of the test instance. |
| InstanceSpecification |
string |
インスタンスのタイプ。
|
HYBRID |
| PaymentType |
string |
課金方法。
|
Subscription |
| StorageType |
string |
ストレージタイプ。
|
HYBRID |
| VCUQuota |
integer |
VCU クォータ。 |
3 |
| InstanceStatus |
string |
インスタンスのステータス。
|
normal |
| CreateTime |
string |
インスタンスが作成された時刻。 |
2019-04-07T09:19:21Z |
| IsMultiAZ |
boolean |
インスタンスでゾーン冗長ストレージ (ZRS) が有効になっているかどうかを示します。
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "E734979F-5A44-5993-9CE5-C23103576923",
"TotalCount": 2,
"NextToken": "CAESCG15aC1xxxxx",
"Instances": [
{
"InstanceName": "instance-test",
"ResourceGroupId": "rg-acfmxh4em5jnbcd",
"RegionId": "cn-huhehaote",
"SPInstanceId": "ots_standard_public_cn-g4t3igqjj002",
"AliasName": "instance-test",
"UserId": "13542356466",
"InstanceDescription": "Description of the test instance.",
"InstanceSpecification": "HYBRID",
"PaymentType": "Subscription",
"StorageType": "HYBRID",
"VCUQuota": 3,
"InstanceStatus": "normal",
"CreateTime": "2019-04-07T09:19:21Z",
"IsMultiAZ": true
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。