ListKnowledgeBases - 获取知识库的列表-数据管理 DMS-阿里云帮助中心

分页查询知识库的列表

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Tag	string	是	知识库标签。在 DataAgent 产品里是空间 ID	1dq7qod8hxtt1***
NamePattern	string	否	知识库名字包含的字段	order
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	zCXSmY0CJbybp6FZV7vo0Wjw64X-*****
MaxResults	integer	否	限定每次返回的最大条数，可以和 NextToken 搭配使用实现翻页能力。	20
Filters	string	否	知识库的过滤条件，JSON 字符串表示。 JSON 取值： state：0/1	{"state":1}
SortFieldName	string	否	排序字段，取值： id：知识库 ID（默认值） name: 知识库名字枚举值： name : name id : id	name
SortOrder	string	否	排序方向。取值范围： ASC（默认值）：升序 DESC：降序枚举值： ASC : ASC DESC : DESC	Desc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	E0D21075-CD3E-4D98-8264-FD8AD04A63B6
Data	array	返回的结构体
	OneMetaKnowledgeBase	返回结果
Success	boolean	请求是否成功，返回值如下：true：请求成功 false：请求失败	true
ErrorCode	string	错误码，请求异常时返回。	UnknownError
ErrorMessage	string	错误信息	Specified parameter Tag is not valid.
TotalCount	integer	满足条件的知识库总数（目前暂不支持，返回值恒定为 0）	0
MaxResults	integer	分页大小。	20
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	NesLoKLEdIZrKhDT7I2gS****

示例

正常返回示例

JSON格式

{
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "Data": [
    {
      "KbUuid": "",
      "Name": "",
      "Description": "",
      "State": 0,
      "Tag": "",
      "Creator": "",
      "GmtCreate": "",
      "GmtModified": "",
      "Domain": "",
      "ExtraInfo": ""
    }
  ],
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "Specified parameter Tag is not valid.",
  "TotalCount": 0,
  "MaxResults": 20,
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****"
}

错误码

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

变更历史

更多信息，参考变更详情。