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

Consulta una lista de bases 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:DescribeKnowledgeBases

get

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

POST  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
KnowledgeSpaceId	string	No	El identificador único del espacio de conocimiento.	pks-xxxxxx
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	30
Keyword	string	No	La palabra clave que se usa para filtrar las bases de conocimiento.	kbPrueba
Status	string	No	El estado de la base de conocimiento.	Activation

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	CDB3258F-B5DE-43C4-8935-CBA0CA******
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valores válidos: 30, 50 y 100. Valor predeterminado: 30.	30
TotalRecordCount	integer	El número total de registros.	1
Items	array<object>	La lista de bases de conocimiento.
	object
KnowledgeBaseId	string	El identificador único de la base de conocimiento.	pkb-xxxxxx
Name	string	El nombre de la base de conocimiento.	nombrePrueba
Description	string	La descripción de la base de conocimiento.	descPrueba
KnowledgeSpaceId	string	El ID del espacio de conocimiento.	pks-xxxxxx
KnowledgeBaseType	string	El tipo de la base de conocimiento. Valores válidos: PUBLIC: pública. PERSONAL: personal.	PUBLIC
TotalDocs	integer	El número total de documentos.	1
TotalSizeBytes	integer	El tamaño total en bytes.	231984
Status	string	El estado de la base de conocimiento.	Activation
CreationTime	string	La hora de creación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2025-03-25T09:37:10Z
BindingAppCount	integer	El número de aplicaciones de IA que están asociadas con la base de conocimiento.	2

Ejemplos

Respuesta exitosa

JSON Formato

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

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.