GetAdvanceConfigFile - 获取词典信息 - 智能开放搜索 OpenSearch

接口说明

方法

GET

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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	Schema of Response
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"

      }

    }

  }

}

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。