UpdateDict_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

调用此接口时，请注意：

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:UpdateDict	Update	Instance acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}	无	无

请求语法

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

路径参数

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:es-cn-nif1q9o8r0008****参考取值来源: ListInstance

请求参数

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

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

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
Resultarray<object>	返回结果。

返回示例

变更历史

	变更时间	变更内容概要	操作
	2022-08-30	删除错误码400

UpdateDict_Elasticsearch_API文档

接口说明

流控信息

授权信息

请求语法

路径参数

请求参数

请求说明

RequestBody

返回参数

返回示例

变更历史

相关示例