DescribeKBSyncLinks - PolarDB - Centro de documentación de Alibaba Cloud

Consulta la lista de enlaces de sincronización de la base de conocimiento.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeKBSyncLinks

get

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

GET  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región.	cn-beijing
KnowledgeBaseId	string	Sí	El ID único de la base de conocimiento.	pkb-xxxxx
ImPlatform	string	No	El canal de origen del enlace de sincronización.	FEISHU
PageNumber	integer	No	El número de página de los resultados de la consulta. Valor predeterminado: 1.	1
PageSize	integer	No	El número de enlaces de sincronización devueltos por página. Valores válidos: 10, 20, 30, 50, 100, 200 y 500. Valor predeterminado: 30.	30

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
Items	array<object>	La lista de enlaces de sincronización.
	object	La información del enlace de sincronización.
ClientId	string	El ID del cliente.	cli_xxxxxxbe8
CreationTime	string	La hora de creación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2026-08-11T09:55:19Z
Description	string	La descripción del enlace de sincronización.	descPrueba
ImPlatform	string	El canal de origen del enlace de sincronización.	FEISHU
LinkId	string	El ID del enlace de sincronización.	pkbl-xxxxx
LinkName	string	El nombre del enlace.	nombrePrueba
SourceDir	string	La dirección del directorio de origen para la sincronización.	https://example.feishu.cn/wiki/space/xxxxxx
SyncIntervalMinutes	integer	El intervalo de sincronización. Unidad: minutos.	30
SyncStatus	string	El estado de sincronización. Valores válidos: CREATING RUNNING PAUSED DELETING	RUNNING
PageNumber	integer	El número de página de los resultados actuales.	1
PageSize	integer	El número de registros por página en los resultados actuales.	30
RequestId	string	El ID de la solicitud.	EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
TotalRecordCount	integer	El número total de enlaces de sincronización que coinciden con las condiciones de consulta.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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",
      "SyncIntervalMinutes": 30,
      "SyncStatus": "RUNNING"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "EB07CFF0-D8A4-5C76-AED7-D00E26FC2***",
  "TotalRecordCount": 1
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.