OpenSearch の GetIndexVersion API とインデックスバージョンロールバック - OpenSearch

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version

今すぐお試しください

この 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:GetIndexVersion

get

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version HTTP/1.1

パスパラメーター

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

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

例

リクエスト例

GET  /openapi/ha3/instances/ha3_instance_id_1/clusters/cluster1/index-version

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
requestId	string	リクエスト ID。	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	クラスター。
cluster	string	クラスター名。	hz_pre_vpc_domain_1
indexVersions	array<object>	インデックスバージョンの配列。
	object	インデックスバージョンのリスト。
indexName	string	インデックステーブル名。	test_api
versions	array	インデックスバージョンの配列。
	integer	インデックスバージョン。	1630353700
buildDeployId	string	オフラインデプロイメントの ID。	2648
currentVersion	integer	現在のオンラインバージョン番号。	1

レスポンス例

成功レスポンス

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "cluster": "ea119cloud",
    "indexVersions": [
      {
        "versions": [
          1630527077,
          1630440554
        ],
        "currentVersion":1630527077,
        "indexName": "ihome_lapp_content_filter_param_index",
        "buildDeployId": "2837"
      },
      {
        "versions": [
          1630353700
        ],
        "currentVersion":1630353700,        
        "indexName": "ihome_lapp_case_tab_filter",
        "buildDeployId": "2829"
      }
    ]
  }
}

例

成功レスポンス

JSONJSON

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "cluster": "hz_pre_vpc_domain_1",
    "indexVersions": [
      {
        "indexName": "test_api",
        "versions": [
          1630353700
        ],
        "buildDeployId": "2648",
        "currentVersion": 1
      }
    ]
  }
}

エラーコード

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

変更履歴

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