ListSynonyms - 同义词列表

更新时间:2025-03-12 12:50:22

获取当前指定业务空间下的同义词列表

调试

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

授权信息

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

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

请求语法

POST /gbi/list/synonyms HTTP/1.1

请求参数

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

当前请求所使用的百炼业务空间 id

llm-2v3934xtp49esw64
bodyobject

请求体参数

nextTokenstring

分页游标。

  • 如果是首次调用,该参数不传。

  • 如果是非首次调用,该参数传上传调用时返回的 nextToken。

e8Z0nRyY51ZQmYljqGNK
maxResultslong

每页最大条目数

10

返回参数

名称类型描述示例值
名称类型描述示例值
object

Result

dataany

返回信息

{ "data": { "data": [ { "gmtModified": 1734401404000, "columns": [ "test.id", "user_info.createdt" ], "synonymIdKey": "synonyms-AAAAAAAAAVLaD8z63NnFhA", "wordSynonyms": [ "1" ], "workSpaceId": "10024809", "gmtCreate": 1734401404000, "word": "1", "status": 1 } ], "nextToken": "k1BLjEN114wyfrhDHoJlbg==", "totalCount": 0 } }
errorMsgstring

错误描述信息。

NoAuth
codestring

错误码

NoAuth
successboolean

调用是否成功。 true,表示成功; false,表示失败。

true
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

D02D895A-5E58-5A9F-963D-D8B027AB7AE2

示例

正常返回示例

JSON格式

{
  "data": "{\n  \"data\": {\n    \"data\": [\n      {\n        \"gmtModified\": 1734401404000,\n        \"columns\": [\n          \"test.id\",\n          \"user_info.createdt\"\n        ],\n        \"synonymIdKey\": \"synonyms-AAAAAAAAAVLaD8z63NnFhA\",\n        \"wordSynonyms\": [\n          \"1\"\n        ],\n        \"workSpaceId\": \"10024809\",\n        \"gmtCreate\": 1734401404000,\n        \"word\": \"1\",\n        \"status\": 1\n      }\n    ],\n    \"nextToken\": \"k1BLjEN114wyfrhDHoJlbg==\",\n    \"totalCount\": 0\n  }\n}",
  "errorMsg": "NoAuth",
  "code": "NoAuth",
  "success": true,
  "requestId": "D02D895A-5E58-5A9F-963D-D8B027AB7AE2"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
401Internal.ErrorBad Request: Internal Error.内部错误,请联系客服人员排查
401NoAuthBad Request: Workspace.Illegal.Auth.当前所使用的账号无所指定业务空间的权限
401NoResourceAuthBad Request: Resource Auth Error.没有请求的资源的权限,请确保所请求的资源属于当前参数中的业务空间
401SystemOperationInProgressXiyan GBI is learning your previous modifications. Please try again later.析言GBI正在学习您之前的修改内容,请稍后重试

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等