GetTableInstructions - Data Management - Centro de documentación de Alibaba Cloud

Obtiene las instrucciones de uso y el contexto empresarial de una tabla, incluida su descripción empresarial, resumen y activos relacionados.

Descripción de la operación

Obtiene las instrucciones de uso y el contexto empresarial de una tabla. Esta operación devuelve una descripción empresarial mejorada con IA, un resumen de la tabla y una lista de activos relacionados. Esta información le ayuda a encontrar tablas de forma semántica y a comprender su uso.

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

POST / HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DbId	integer	Sí	El ID de la base de datos. Puede llamar a la API ListDatabases para obtener este ID.	1***
TableName	string	Sí	El nombre de la tabla.	order_info

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	El código de error.	UnknownError
ErrorMessage	string	El mensaje de error.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Data	TableInstructionsVO	Las instrucciones de la tabla obtenidas.	1001

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "DbId": 0,
    "DbType": "",
    "TableName": "",
    "AssetDescription": "",
    "Summary": "",
    "AssetCreatedGmt": "",
    "AssetModifiedGmt": ""
  }
}

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.