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

Llama a la operación GetMetaTableDetailInfo para obtener detalles sobre una tabla, como sus campos e índices.

Descripción de la operación

Solo las instancias de base de datos en el modo de control de Colaboración de Seguridad pueden llamar a esta API.

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:GetMetaTableDetailInfo

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Nota Puede encontrar el ID del inquilino al pasar el cursor sobre su foto de perfil en la esquina superior derecha de la consola. Para obtener más información, consulte Ver información del inquilino.	123
TableGuid	string	Sí	El GUID de la tabla en DMS. Nota Para una base de datos lógica, llame a la operación ListLogicTables y establezca el parámetro ReturnGuid en true. Para una base de datos física, llame a la operación ListTables y establezca el parámetro ReturnGuid en true.	IDB_L_9032.db-test.yuyang_test
RealLoginUserUid	string	No	El ID de usuario del llamador de la API.	12345

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
DetailInfo	object	Los detalles de la tabla.
IndexList	array<object>	La lista de índices.
	object
IndexColumns	array	Una lista de columnas de índice.
	string	Una columna de índice.	id
IndexName	string	El nombre del índice.	PRIMARY
Unique	boolean	Especifica si el índice es único. Valores válidos: `true`: El índice es único. `false`: El índice no es único.	false
IndexType	string	El tipo de índice, como `Primary`, `Unique` o `Normal`.	Primary
IndexId	string	El ID del índice.	123
ColumnList	array<object>	La lista de columnas.
	object
ColumnName	string	El nombre de la columna.	id
Description	string	La descripción de la columna.	test
DataScale	integer	La escala de la columna, que es el número de dígitos a la derecha del punto decimal.	0
DataPrecision	integer	La precisión de la columna, que es el número total de dígitos en un valor numérico.	0
ColumnType	string	El tipo de datos de la columna, como `Bigint`, `Int` o `Varchar`.	bigint(20) unsigned
AutoIncrement	boolean	Especifica si la columna se incrementa automáticamente. Valores válidos: `true`: La columna se incrementa automáticamente. `false`: La columna no se incrementa automáticamente.	true
Position	string	La posición de la columna en la tabla.	1
Nullable	boolean	Especifica si la columna puede contener valores nulos. Valores válidos: `true`: La columna puede contener valores nulos. `false`: La columna no puede contener valores nulos.	false
ColumnId	string	El ID de la columna.	191234849
DataLength	integer	La longitud de los datos en la columna.	0
ErrorCode	string	El código de error que se devuelve cuando ocurre un error.	UnknownError
ErrorMessage	string	El mensaje de error que se devuelve cuando ocurre un error.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
  "DetailInfo": {
    "IndexList": [
      {
        "IndexColumns": [
          "id"
        ],
        "IndexName": "PRIMARY",
        "Unique": false,
        "IndexType": "Primary",
        "IndexId": "123"
      }
    ],
    "ColumnList": [
      {
        "ColumnName": "id",
        "Description": "test",
        "DataScale": 0,
        "DataPrecision": 0,
        "ColumnType": "bigint(20) unsigned",
        "AutoIncrement": true,
        "Position": "1",
        "Nullable": false,
        "ColumnId": "191234849",
        "DataLength": 0
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

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.