インデックステーブルステータス向け ListTables API の概要 - OpenSearch

操作説明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/tables

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:ListTables

list

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId}/tables HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
newMode	boolean	任意	OpenSearch Vector Search Edition インスタンスが新しいバージョンであるかどうかを指定します。	true

サンプルリクエスト

GET /openapi/ha3/instances/{instanceId}/tables

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	結果。
	object
name	string	インデックス名。	es_test_1b
indexStatus	string	インデックステーブルの状態。有効な値：NEW、PUBLISH、IN_USE、NOT_USE、STOP_USE、RESTORE_USE、FAIL。OpenSearch Retrieval Engine Edition インスタンスでインデックスが作成されると、インデックスは IN_USE 状態になります。新しいバージョンの OpenSearch Vector Search Edition インスタンスで最初の完全なインデックスの作成に失敗した場合、インデックスは FAIL 状態になります。	IN_USE
status	string	インデックステーブルの状態。有効な値：NEW、PUBLISH、IN_USE、NOT_USE、STOP_USE、RESTORE_USE、FAIL。OpenSearch Retrieval Engine Edition インスタンスでインデックスが作成されると、インデックスは IN_USE 状態になります。新しいバージョンの OpenSearch Vector Search Edition インスタンスで最初の完全なインデックスの作成に失敗した場合、インデックスは FAIL 状態になります。	IN_USE

例

成功レスポンス

JSONJSON

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "name": "es_test_1b",
      "indexStatus": "IN_USE",
      "status": "IN_USE"
    }
  ]
}

エラーコード

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

変更履歴

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