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

Descripción de la operación

Esta API solo se puede llamar para instancias de base de datos que tienen habilitada la administración de seguridad.

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

dms:GetTableKnowledgeInfo

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TableSchemaName	string	No	El nombre del esquema de la tabla, que es obligatorio solo para instancias de SQL Server.	dbo
DbId	integer	Sí	El ID de la base de datos física. Puede llamar a la operación SearchDatabase para obtener el ID.	325
TableName	string	Sí	El nombre de la tabla.	table_name

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de respuesta.
RequestId	string	El ID de la solicitud. Puede utilizar el ID de la solicitud para consultar registros y solucionar problemas.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Table	TableKnowledgeInfo	La información sobre la tabla.	bill_orders

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Table": {
    "TableName": "",
    "Description": "",
    "AssetDescription": "",
    "AssetModifiedGmt": "",
    "Summary": "",
    "ColumnList": [
      {
        "Description": "",
        "ColumnType": "",
        "AssetDescription": "",
        "Position": 0,
        "AssetModifiedGmt": "",
        "ColumnName": "",
        "Level": 0
      }
    ],
    "Level": 0
  }
}

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.