文档

UpdateDict - 创建或修改词典

更新时间:

调用UpdateDict接口,创建或修改ES Serverless应用词典。目前仅支持通过OSS地址上传。

接口说明

系统将自动创建服务关联角色,允许访问 OSS 等其他云产品服务。 OSS 地址要求:目录名称需包含 es-serverless,或为 OSS Bucket 添加 es-serverless:es-serverless 标签。

调试

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

授权信息

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

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

请求语法

PUT /openapi/es-serverless/instances/{appName}/dicts

请求参数

名称类型必填描述示例值
bodyobject

body 参数

filesarray<object>

文件信息。

object

文件信息。

namestring

上传的词典文件名称。

dic_0.dic
ossObjectobject

OSS 存储配置详情。

bucketNamestring

OSS Bucket 名称。

bucket1
keystring

词典文件在 OSS Bucket 中的存储路径。

oss/dic_0.dic
typestring

要更新的词典类型:

  • MAIN:IK 主分词词库
  • STOP:IK 停用词库
MAIN
sourceTypestring

词典文件来源类型。目前仅支持 OSS(使用 OSS 开放存储)。

OSS
appNamestring

应用名称。

test
dryRunboolean

是否校验入参数据合法性并创建或修改词典信息,默认 false。

  • true:只校验参数合法性。

  • false:校验参数合法性,并创建或修改词典信息。

true
allowCoverboolean

是否允许覆盖同名的词典,默认 false。

  • false:不允许覆盖同名词典,若存在同名的词典会报错。
  • true:允许覆盖同名的词典。
true

返回参数

名称类型描述示例值
object

请求结果。

requestIdstring

请求 ID。

12797BCC-E0B5-5A47-B4B9-A14DDF0B0200
resultboolean

返回结果。

true

示例

正常返回示例

JSON格式

{
  "requestId": "12797BCC-E0B5-5A47-B4B9-A14DDF0B0200",
  "result": true
}

错误码

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