GetAdvanceConfig API による詳細設定の取得 - OpenSearch

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}

今すぐお試しください

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

get

*Instance

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
configName	string	必須	詳細設定の名前。	ha-cn-pl32rf0****_offline_adv_edit

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
type	string	任意	詳細設定のタイプ。有効な値：-ONLINE：オンライン構成 -ONLINE_CAVA：オンライン Cava 構成 -ONLINE_PLUGIN：オンラインプラグイン構成 -ONLINE_QUERY：クエリ構成 -OFFLINE_DICT：オフライン辞書構成 -OFFLINE_TABLE：オフラインテーブル構成 -OFFLINE_COMMON：オフライン構成 -OFFLINE_PLUGIN：オフラインプラグイン構成 -OFFLINE_INDEX：インデックス構成	ONLINE

リクエスト例

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

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
requestId	string	リクエスト ID。	E45380E8-994A-5402-9806-F114B3295FCF
result	object	結果。
updateTime	integer	詳細設定が更新された時間。	2024-05-21 16:05:26
desc	string	詳細設定の説明。	自定义备注信息
files	array<object>	ファイル。
	object	ファイルの配列。
name	string	ファイル名。	ha-cn-pl32rf0****_qrs
fullPathName	string	ファイルパス。	/cluster
isDir	boolean	ファイルがディレクトリであるかどうかを示します。	true
isTemplate	boolean	ファイルがテンプレートであるかどうかを示します。	true
content	string	返される詳細設定のコンテンツ。	{\"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：詳細設定は削除中です。	used

レスポンス例

成功レスポンス

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name": "my_index",
    "status": "drafting",
    "updateTime": 1631070464000,
    "desc":"テスト",
    "files": [
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      },
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      }
    ]    
  }
}

例

成功レスポンス

JSONJSON

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "updateTime": 0,
    "desc": "自定义备注信息",
    "files": [
      {
        "name": "ha-cn-pl32rf0****_qrs",
        "fullPathName": "/cluster",
        "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": "used"
  }
}

エラーコード

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

変更履歴

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