GetAdvanceConfigFile API による詳細設定ファイルの取得 - OpenSearch

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file?fileName={fileName}

今すぐお試しください

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

get

*Instance

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

なし

リクエスト構文

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

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
fileName	string	必須	ファイル名。	/intervene_dict/chn_ecommerce_general.dict

リクエストのサンプル

GET  /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name?fileName=/root/test.txt

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
requestId	string	リクエスト ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	結果。
content	string	ファイルの内容。	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}

レスポンスのサンプル

成功レスポンスの例

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": {

    "content": "",

    "variables": {

      "qrs_request_compress_type": {

        "description": "",

        "disableModify": false,

        "isModify": false,

        "type": "NORMAL",

        "value": "z_speed_compress"

      },

      "qrs_connection_timeout": {

        "description": "",

        "disableModify": false,

        "isModify": true,

        "type": "NORMAL",

        "value": "800"

      },

      "qrs_return_hits_limit": {

        "description": "",

        "disableModify": false,

        "isModify": false,

        "type": "NORMAL",

        "value": "5000"

      },

      "primary_table_name": {

        "disableModify": false,

        "funcValue": {

          "funcClassName": "com.taobao.search.moss.resource.api.plugin.config.function.impl.MainOnlineTableFunction"

        },

        "isModify": false,

        "type": "FUNCTION",

        "value": "$primary_table_name"

      },

      "__cluster_name": {

        "disableModify": false,

        "isModify": true,

        "type": "NORMAL",

        "value": "general"

      }

    }

  }

}

例

成功レスポンス

JSONJSON

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {
    "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}"
  }
}

エラーコード

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

変更履歴

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