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

获取词典信息。

接口说明

方法

GET

URI

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
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****
type	string	否	-ONLINE: 在线配置, -ONLINE_CAVA: 在线 cava 配置, -ONLINE_PLUGIN: 在线插件, -ONLINE_QUERY: 查询配置, -OFFLINE_DICT: 离线配置, -OFFLINE_TABLE: 离线表, -OFFLINE_COMMON: 离线配置, -OFFLINE_PLUGIN: 离线插件, -OFFLINE_INDEX: 索引配置	ONLINE
configName	string	是	配置名称	ha-cn-pl32rf0****_offline_adv_edit

请求示例

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

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID	E45380E8-994A-5402-9806-F114B3295FCF
result	object	结果
updateTime	long	更新时间	2024-05-21 16:05:26
desc	string	描述	自定义备注信息
files	array<object>	文件列表。
file	object	文件信息。
name	string	名称	ha-cn-pl32rf0****_qrs
fullPathName	string	文件路径	/cluster
isDir	boolean	是目录	true
isTemplate	boolean	是容器	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: 删除中)	used

返回示例

正确返回

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

示例

正常返回示例

JSON格式

{
  "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"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-01-12	新增 OpenAPI	查看变更详情