ListAdvanceConfigs API で HA3 詳細設定をクエリ - OpenSearch

詳細設定のリストを取得します。

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs?type=online

今すぐお試しください

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

list

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId}/advanced-configs HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
type	string	任意	詳細設定のタイプ。有効な値: - online - offline (デフォルト)	online
dataSourceName	string	任意	データソース名。	ha-cn-pl32rf0****_test_api
indexName	string	任意	インデックス名。	test_api
newMode	boolean	任意	ページの新しいバージョンを使用するかどうかを指定します。	true
pageNumber	string	任意	ページ番号。デフォルト値は 1 です。	1
pageSize	string	任意	各ページで返されるエントリ数。デフォルト値は 10 です。	10

リクエストの例

GET /openapi/ha3/instances/ose-test1/advanced-configs

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	返された結果。
	object	詳細設定のリスト。
updateTime	integer	更新時間。	1631070464000
desc	string	説明。	Custom Description
files	array<object>	ファイルのリスト。
	object	ファイル情報。
name	string	ファイル名。	file_name_1
fullPathName	string	絶対パス。	/path/wpd/nae
isDir	boolean	ファイルがディレクトリであるかどうかを指定します。有効な値: - `true` - `false`	true
isTemplate	boolean	ファイルがテンプレートであるかどうかを指定します。有効な値: - `true` - `false`	true
content	string	設定内容。このパラメーターは、HTTP および Git リクエストに対して返されます。	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
contentType	string	設定内容のタイプ。有効な値: FILE、GIT、HTTP、および ODPS。	FILE
name	string	詳細設定の名前。	my_index
status	string	詳細設定のステータス。有効な値: - `drafting`: 設定はドラフトです。 - `used`: 設定は使用中です。 - `unused`: 設定は使用されていません。 - `trash`: 設定は削除中です。	drafting
creator	string	設定を作成したユーザーの ID。	123456
advanceConfigType	string	ONLINE: オンライン設定 ONLINE_CAVA: オンライン Cava 設定 ONLINE_PLUGIN: オンラインプラグイン ONLINE_QUERY: クエリ設定 OFFLINE_DICT: オフライン辞書設定 OFFLINE_TABLE: オフラインテーブル設定 OFFLINE_COMMON: 共通オフライン設定 OFFLINE_PLUGIN: オフラインプラグイン OFFLINE_INDEX: インデックス設定	ONLINE

レスポンスの例

成功レスポンス

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "my_index",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    },
    {
      "name": "my_index2",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    }
  ]
}

例

成功レスポンス

JSONJSON

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "updateTime": 1631070464000,
      "desc": "Custom Description",
      "files": [
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ],
      "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
      "contentType": "FILE",
      "name": "my_index",
      "status": "drafting",
      "creator": "123456",
      "advanceConfigType": "ONLINE"
    }
  ]
}

エラーコード

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

変更履歴

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