请求语法
请求方法+URL
PUT /openapi/instances/[InstanceId]/synonymsDict HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
InstanceId |
String |
Path |
是 |
es-cn-nif1q9o8r0008**** |
实例ID。 |
clientToken |
String |
Query |
否 |
5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。 |
RequestBody |
Json |
是 |
具体见 RequestBody |
body内容 |
RequestBody
RequestBody中还需填入以下参数。
参数 |
类型 |
是否必须 |
示例值 |
描述 |
name |
String |
是 |
test.txt |
上传的词典文件名称，必须为TXT类型，这个是文件存储在ES集群 中的文件名称，如果是更新，必须和之前集群的同义词文件名相同， 可能和key名称不一样。 |
ossObject |
Array |
否 |
OSS的开放存储文件描述。当sourceType为OSS时，必填。 |
|
└bucketName |
String |
否 |
search-cloud-test-cn-**** |
OSS存储空间（Bucket）名称。 |
└key |
String |
否 |
oss/dic_0.txt |
词典文件在OSS Bucket中的存储路径，包括目录和同义词文件名， 文件名后缀可以是dic。 |
sourceType |
String |
是 |
OSS |
词典文件来源类型，可选值：OSS（使用OSS开放存储，覆盖更新同 名文件的内容）、ORIGIN（保留之前已经上传的词典，也就是追加文件，一般追加）。 |
type |
String |
是 |
SYNONYMS |
要更新的词典类型，固定为SYNONYMS。 |
示例
请求示例
常见问题
An error occurred while retrieving the OSS file information. Check the OSS configuration and try again
1.OSS文件没有公共读权限。
2.sourceType配置了OSS（同名文件数据覆盖），但是name和集群上同义词文件不一致。
3.type配置的不是SYNONYMS。
The specified format is invalid. Check the parameter format and try again
1.body格式错误，常见的就是body最外层的大括号（[ ]）没写。
The cluster is running tasks or in an error status. Try again later
1.集群不是健康状态。
The specified dictionary name is invalid
1.name（ES集群文件名）必须是txt类型，如果是dic就会报这个错误。
接口调用成功，但是集群重启后，同义词文件内容没有更新
1.sourceType设置为ORIGIN，并且name和集群同义词文件名一致，导致追文件没加文件，导致有同名文件存在，所以集群重启后是没有结果的。
