DescribeKBSyncLinks - PolarDB - Alibaba Cloud Documentation Center

Queries the list of knowledge base synchronization links.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeKBSyncLinks

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
KnowledgeBaseId	string	Yes	The unique ID of the knowledge base.	pkb-xxxxx
ImPlatform	string	No	The source channel of the synchronization link.	FEISHU
PageNumber	integer	No	The page number of the query results. Default value: 1.	1
PageSize	integer	No	The number of synchronization links returned per page. Valid values: 10, 20, 30, 50, 100, 200, and 500. Default value: 30.	30

Response elements

Element	Type	Description	Example
	object	Schema of Response
Items	array<object>	The list of synchronization links.
	object	The synchronization link information.
ClientId	string	The client ID.	cli_xxxxxxbe8
CreationTime	string	The creation time. The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2026-08-11T09:55:19Z
Description	string	The description of the synchronization link.	testDesc
ImPlatform	string	The source channel of the synchronization link.	FEISHU
LinkId	string	The synchronization link ID.	pkbl-xxxxx
LinkName	string	The link name.	testName
SourceDir	string	The source directory address for synchronization.	https://example.feishu.cn/wiki/space/xxxxxx
SyncIntervalMinutes	integer	The synchronization interval. Unit: minutes.	30
SyncStatus	string	The synchronization status. Valid values: CREATING RUNNING PAUSED DELETING	RUNNING
PageNumber	integer	The page number of the current results.	1
PageSize	integer	The number of records per page in the current results.	30
RequestId	string	Id of the request	EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
TotalRecordCount	integer	The total number of synchronization links that match the query conditions.	1

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.