DescribeKBSyncLinks - 查询知识库同步列表 - 云原生数据库 PolarDB

查询知识库同步列表

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeKBSyncLinks

get

*全部资源

*

无

请求语法

GET  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID	cn-beijing
KnowledgeBaseId	string	是	知识库唯一标识	pkb-xxxxx
ImPlatform	string	否	同步链路来源渠道	FEISHU
PageNumber	integer	否	查询结果的页码，默认值为 1	1
PageSize	integer	否	每页返回的同步链路数量，取值为 10、20、30、50、100、200 或 500，默认值为 30	30

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Items	array<object>	同步链路列表
	object	同步链路信息
ClientId	string	客户端标识	cli_xxxxxxbe8
CreationTime	string	创建时间时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。	2026-08-11T09:55:19Z
Description	string	同步链路描述	testDesc
ImPlatform	string	同步链路来源渠道	FEISHU
LinkId	string	同步链路 ID	pkbl-xxxxx
LinkName	string	链路名称	testName
SourceDir	string	同步源目录地址	https://example.feishu.cn/wiki/space/xxxxxx
SyncIntervalMinutes	integer	同步时间间隔，单位：分钟	30
SyncStatus	string	同步状态，取值： CREATING RUNNING PAUSED DELETING	RUNNING
PageNumber	integer	当前返回结果的页码	1
PageSize	integer	当前返回结果的每页记录数	30
RequestId	string	Id of the request	EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
TotalRecordCount	integer	符合查询条件的同步链路总数	1

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "ClientId": "cli_xxxxxxbe8",
      "CreationTime": "2026-08-11T09:55:19Z",
      "Description": "testDesc",
      "ImPlatform": "FEISHU",
      "LinkId": "pkbl-xxxxx",
      "LinkName": "testName",
      "SourceDir": "https://example.feishu.cn/wiki/space/xxxxxx\n",
      "SyncIntervalMinutes": 30,
      "SyncStatus": "RUNNING"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "EB07CFF0-D8A4-5C76-AED7-D00E26FC2***",
  "TotalRecordCount": 1
}

错误码

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

变更历史

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