潜在的なリーダーのインスタンスのリストを取得します。
操作説明
リクエスト
この API は、特定の Hologres インスタンスに紐づくプライマリインスタンスのリストを取得します。
instanceIdパラメータは任意です。省略した場合、デフォルトで関連するすべてのインスタンスを返します。この API は Hologres AI ノードに適用されます。AI ノード以外では、一部のパラメータが無効となる場合があります。
この操作を呼び出す前に、Alibaba Cloud Hologres の課金と料金を確認してください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /api/v1/instances/{instanceId}/primaryInstances HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
任意 |
インスタンス ID。 |
hgprecn-cn-zxu3001jn00d |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
5600196E-78E2-50F2-B2A1-C44D3B665438 |
| InstanceList |
array<object> |
インスタンスのリスト。 |
|
|
array<object> |
インスタンスの詳細を含みます。 |
||
| ChargeType |
string |
課金方法。 列挙値:
|
PostPaid |
| CommodityCode |
string |
商品コード。 |
hologram_combo_public_cn |
| CreationTime |
string |
作成時刻。 |
2022-07-25T02:15:35Z |
| ExpirationTime |
string |
有効期限。このパラメータは、従量課金インスタンスでは返されません。 |
2022-07-25T02:15:35Z |
| InstanceId |
string |
インスタンス ID。 |
hgpostcn-cn-tl32vsdir00h |
| InstanceName |
string |
インスタンス名。 |
user_defined_name |
| InstanceStatus |
string |
インスタンスステータス。 列挙値:
|
Running |
| InstanceType |
string |
インスタンスタイプ。 列挙値:
|
Standard |
| Tags |
array<object> |
タグのリスト。 |
|
|
object |
タグオブジェクト。 |
||
| Key |
string |
タグのキー。 |
tagKey |
| Value |
string |
タグの値。 |
value |
| BindingCode |
string |
プライマリインスタンスとフォロワーインスタンスの互換性を示します。値が |
0 |
| Success |
string |
リクエストが成功したかどうかを示します。このフィールドは、操作の実行結果を反映するものではありません。 列挙値:
|
true |
| ErrorCode |
string |
エラーコード。 |
404 |
| ErrorMessage |
string |
エラーメッセージ。 |
Internal server error. |
| HttpStatusCode |
string |
HTTP ステータスコード。 |
200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "5600196E-78E2-50F2-B2A1-C44D3B665438",
"InstanceList": [
{
"ChargeType": "PostPaid",
"CommodityCode": "hologram_combo_public_cn",
"CreationTime": "2022-07-25T02:15:35Z",
"ExpirationTime": "2022-07-25T02:15:35Z",
"InstanceId": "hgpostcn-cn-tl32vsdir00h",
"InstanceName": "user_defined_name",
"InstanceStatus": "Running",
"InstanceType": "Standard",
"Tags": [
{
"Key": "tagKey",
"Value": "value"
}
],
"BindingCode": "0"
}
],
"Success": "true",
"ErrorCode": "404",
"ErrorMessage": "Internal server error.",
"HttpStatusCode": "200"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。