ListDateSourceGenerations によるデータソースの履歴インデックスバージョンのクエリ - OpenSearch

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}

今すぐお試しください

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

list

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations HTTP/1.1

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
validStatus	boolean	任意	返されるインデックスバージョンを指定します。有効な値： true (デフォルト)：完了しており、期限切れになっていないインデックスバージョンを返します。 false：すべてのインデックスバージョンを返します。	true
domainName	string	必須	データソースがデプロイされているデータセンター。	bj_vpc_domain_1

リクエスト例

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	リスト
	array<object>	返された結果。
generation	integer	完全なインデックスバージョンの ID。	1626143930
createTime	integer	インデックス構築が開始されたときに生成されたタイムスタンプ。	1626143673
status	string	インデックスバージョンのステータス。	STOPPED
buildDeployId	integer	オフラインデプロイメントの ID。	122
partition	object	インデックスバージョンのシャード。値はキーと値のペアで、キーはインデックス名、値はシャード数を示します。
	integer	シャード数。	1
timestamp	integer	増分データが取得される開始タイムスタンプ。	1626143673
dataDumpRoot	string	Apsara File Storage for HDFS ファイルシステム内のダンプされたインデックスのパス。	hdfs://opensearch/dump.json

レスポンス例

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "generationId":1626143930,
      "timestamp":16261436737,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    },{
      "generationId":1626143930,
      "timestamp":16261435453,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    }
  ]
}

例

成功レスポンス

JSONJSON

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "generation": 1626143930,
      "createTime": 1626143673,
      "status": "STOPPED",
      "buildDeployId": 122,
      "partition": {
        "key": 1
      },
      "timestamp": 1626143673,
      "dataDumpRoot": "hdfs://opensearch/dump.json"
    }
  ]
}

エラーコード

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

変更履歴

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