ListLeaderInstances - Hologres - Alibaba Cloud ドキュメントセンター

利用可能なプライマリインスタンス ID のリストを取得します。

操作説明

指定された Hologres セカンダリインスタンスに関連付け可能なプライマリインスタンスのリストを取得します。instanceId はパスパラメーターであり、この操作を呼び出す際に指定する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hologram:ListLeaderInstances

list

*インスタンス。

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

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 : サブスクリプション。 PrePaid : サブスクリプション。	PostPaid
CommodityCode	string	商品コード。	hologram_combo_public_cn
CreationTime	string	協定世界時 (UTC) の ISO 8601 フォーマットによる作成時間。	2022-07-25T02:15:35Z
ExpirationTime	string	協定世界時 (UTC) の ISO 8601 フォーマットによる有効期限。従量課金インスタンスに有効期限はありません。	2022-07-25T02:15:35Z
InstanceId	string	インスタンスの ID。	hgpostcn-cn-tl32vsdir00h
InstanceName	string	インスタンス名。	user_defined_name
InstanceStatus	string	インスタンスステータス。列挙値: Creating : 作成中。 Running : 実行中。 Suspended : 一時停止中。 Allocating : 処理中。一部の操作が許可されていない場合があります。	Running
InstanceType	string	インスタンスタイプ。列挙値: Follower : 読み取り専用セカンダリインスタンス。 Standard : 標準。	Standard
Tags	array<object>	タグリスト。
	object	タグリスト。
Key	string	タグキー。	tagKey
Value	string	タグ値。	値
BindingCode	string	プライマリインスタンスとセカンダリインスタンス間の互換性レベル。値が 0 の場合は完全に一致していることを示します。その他の値は不一致を示します。	0
Success	string	リクエストが成功したかどうかを示します。これはビジネスロジックとは無関係です。列挙値: true : 成功。 false : 失敗。	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": "値"
        }
      ],
      "BindingCode": "0"
    }
  ],
  "Success": "true",
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error",
  "HttpStatusCode": "200"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。