文档

ListDicts - 获取词典列表

更新时间:

调用ListDicts接口,获取ES Serverless应用的词典列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

应用名称。

test
pageNumberinteger

页码,默认 1。

1
pageSizeinteger

每页返回的结果数量。

10

返回参数

名称类型描述示例值
object

请求结果。

requestIdstring

请求 ID。

E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3
totalCountinteger

字典总数。

1
resultarray<object>

返回结果。

object

返回结果

namestring

词典名称。

a.dic
typestring

词典类型:

  • MAIN:IK 主分词词库
  • STOP:IK 停用词库
  • SYNONYMS:同义词词库
MAIN
downloadUrlstring

文件下载地址。

http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat
sourceTypestring

词典文件来源类型,可选值:OSS(使用 OSS 开放存储)。

OSS

示例

正常返回示例

JSON格式

{
  "requestId": "E92BCBB9-3CFE-58DD-8D8C-56DF46AB3BF3",
  "totalCount": 1,
  "result": [
    {
      "name": "a.dic",
      "type": "MAIN",
      "downloadUrl": "http://es-serverless-****.oss-cn-hangzhou.aliyuncs.com/app/es7**190/0/config/analysis-ik/stopword.dic?Expires=1705923089&OSSAccessKeyId=STS.NV18q****UkVp6LNj&Signat",
      "sourceType": "OSS"
    }
  ]
}

错误码

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