通义灵码获取知识库成员列表__智能编码助手_AI编程_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 获取知识库成员列表。

适用版本	企业标准版、企业专属版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

请求语法

GET  https://<domain>/oapi/v1/lingma/organizations/<organizationId>/knowledgeBases/<kbId>/members?query=<query>

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	组织 ID。	99d1****71d4
kbId	string	path	是	知识库 ID。	3a41****3eca
query	string	query	否	成员名称模糊查询。
orderBy	string	query	否	排序列，支持如下排序字段：gmt_created。
sort	string	query	否	排序顺序，支持倒序和正序：desc，asc。
page	integer	query	否	当前页，默认1。
perPage	integer	query	否	每页数据条数，默认20。

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/knowledgeBases/3a41****3eca/members?query=lingma' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
displayName	string	成员登录名称。	lingma005
userName	string	成员昵称。	lingma
userId	string	成员 ID。	8582****cd4f
avatarUrl	string	成员头像。	/objects/ajax/default/avatars/bGluZ21hMDA0
kbNo	string	知识库 ID。	3a41****3eca
gmtCreated	integer	添加日期。	1722148166491
creator	object	添加者。
id	string	添加者 ID。	d402****9ae6
displayName	string	添加者登录名称。	lingma
userName	string	添加者昵称。	lingma004
avatarUrl	string	添加者头像。	/objects/ajax/default/avatars/bGluZ21h

返回示例

[
  {
    "displayName": "lingma005",
    "userName": "lingma",
    "userId": "8582****cd4f",
    "avatarUrl": "/objects/ajax/default/avatars/bGluZ21hMDA0",
    "kbNo": "3a41****3eca",
    "gmtCreated": 1722148166491,
    "creator": {
      "id": "d402****9ae6",
      "displayName": "lingma",
      "userName": "lingma004",
      "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h"
    }
  }
]

响应头

参数	描述	示例值
x-next-page	下一页。	1
x-per-page	每页数据条数。	100
x-prev-page	上一页。	1
x-total	总数据量。	2
x-total-pages	总分页数。	1

响应头示例

 connection: keep-alive 
 content-length: 481 
 content-type: application/json; charset=UTF-8 
 date: Thu,04 Jul 2024 13:44:21 GMT 
 x-next-page: 1 
 x-per-page: 100  //每页大小 
 x-prev-page: 1 
 x-total: 2   //总条数
 x-total-pages: 1  //总页数

错误码

访问错误码中心查看 API 相关错误码。