UpdateDict - 更新实例用户词典-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

接口说明

调用此接口时，请注意：

如果词典文件来源于 OSS，需要确保 OSS 存储空间为公共可读。
如果已经上传的词典不加 ORIGIN 配置，调用此接口后，词典文件会被删除。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateDict

update

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无

请求语法

PUT /openapi/instances/{InstanceId}/dict HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-nif1q9o8r0008****

请求参数

名称	类型	必填	描述	示例值
clientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
body	string	否	IK 分词词典的文件名称、来源和 OSS 文件信息。	[{"name":"deploy_0.dic","ossObject":{"bucketName":"search-cloud-test-cn-**","key":"user_dict/dict_0.dic"},"sourceType":"OSS","type":"MAIN"},{"name":"deploy_2.dic","ossObject":{"bucketName":"search-cloud-test-cn-**","key":"user_dict/dict_2.dic"},"sourceType":"OSS","type":"STOP"},{"name":"SYSTEM_MAIN.dic","sourceType":"ORIGIN","type":"MAIN"},{"name":"SYSTEM_STOPWORD.dic","sourceType":"ORIGIN","type":"STOP"}]

RequestBody

RequestBody 中还需填入以下参数。

参数	类型	是否必须	示例值	描述
name	String	是	dic_0.dic	上传的词典文件名称。
ossObject	Array	是		OSS 的开放存储文件描述。当 sourceType 为 OSS 时，必填。
└bucketName	String	是	search-cloud-test-cn-****	OSS 存储空间（Bucket）名称。
└key	String	是	oss/dic_0.dic	词典文件在 OSS Bucket 中的存储路径。
sourceType	String	是	OSS	词典文件来源类型，可选值：OSS（使用 OSS 开放存储）、ORIGIN（保留之前已经上传的词典）。注意：本地文件需要先上传至 OSS，再通过 OSS 引用。如果之前已经完成上传的词典不加 ORIGIN 进行配置，会被系统删除。
type	String	是	MAIN	要更新的词典类型。可选值：MAIN（IK 主分词词库）或 STOP（IK 停用词库）。

说明

└表示子参数。

示例如下。

[
    {
        "name":"deploy_0.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"MAIN"
    },
    {
        "name":"deploy_2.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_2.dic"
        },
        "sourceType":"OSS",
        "type":"STOP"
    },
    {
        "name":"SYSTEM_MAIN.dic",
        "sourceType":"ORIGIN",
         "type":"MAIN"
    },
    {
        "name":"SYSTEM_STOPWORD.dic",
        "sourceType":"ORIGIN",
       "type":"STOP"
    }
]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
Result	array<object>	返回结果。
	object
fileSize	integer	词典文件大小，单位：Byte。	2782602
sourceType	string	词典文件来源类型，支持： OSS：OSS 开放存储 ORIGIN：保留之前已经上传的词典	ORIGIN
name	string	词典文件名称。	SYSTEM_MAIN.dic
type	string	词典类型，支持： MAIN：IK 主分词词库 STOP：IK 停用词词库	MAIN

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****",
  "Result": [
    {
      "fileSize": 2782602,
      "sourceType": "ORIGIN",
      "name": "SYSTEM_MAIN.dic",
      "type": "MAIN"
    }
  ]
}

错误码

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

变更历史

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