全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeKnowledgeBases - 查询知识库列表

更新时间:Aug 28, 2026

查询知识库列表

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeKnowledgeBases

get

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID

cn-beijing

KnowledgeSpaceId

string

知识空间唯一标识

pks-xxxxxx

PageNumber

integer

页码

1

PageSize

integer

每页记录数

30

Keyword

string

知识库关键词

testkb

Status

string

知识库状态

Activation

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

CDB3258F-B5DE-43C4-8935-CBA0CA******

PageNumber

integer

页码。

1

PageSize

integer

每页记录数,取值为 3050100

默认值为 30

30

TotalRecordCount

integer

总记录数。

1

Items

array<object>

知识库列表。

object

KnowledgeBaseId

string

知识库唯一标识

pkb-xxxxxx

Name

string

知识库名称

testName

Description

string

知识库描述

testDesc

KnowledgeSpaceId

string

知识空间 ID

pks-xxxxxx

KnowledgeBaseType

string

知识库类型。取值:PUBLIC、PERSONAL。

PUBLIC

TotalDocs

integer

文档总数

1

TotalSizeBytes

integer

总字节数

231984

Status

string

状态

Activation

CreationTime

string

创建时间

2025-03-25T09:37:10Z

BindingAppCount

integer

已绑定的 AI 应用数量

2

示例

正常返回示例

JSON格式

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "KnowledgeBaseId": "pkb-xxxxxx",
      "Name": "testName",
      "Description": "testDesc",
      "KnowledgeSpaceId": "pks-xxxxxx",
      "KnowledgeBaseType": "PUBLIC",
      "TotalDocs": 1,
      "TotalSizeBytes": 231984,
      "Status": "Activation",
      "CreationTime": "2025-03-25T09:37:10Z",
      "BindingAppCount": 2
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情