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

Consulta los detalles de las columnas de una tabla.

Descripción de la operación

Solo puede llamar a esta operación para instancias de base de datos cuyo modo de control es Colaboració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:GetMetaTableColumn

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant para obtener el ID del inquilino.	3***
TableGuid	string	Sí	El identificador único global (GUID) de la tabla en Data Management (DMS). Si la base de datos a la que pertenece la tabla es una base de datos lógica, puede llamar a la operación ListLogicTables para obtener el valor de este parámetro. Si la base de datos a la que pertenece la tabla es una base de datos física, puede llamar a la operación ListTables para obtener el valor de este parámetro.	IDB_40753****.qntest2.activity_setting

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	087DFBA1-378B-5D25-B13B-31F6409F****
ErrorCode	string	El código de error devuelto.	MissingTableGuid
ColumnList	array<object>	Los detalles de los campos de la tabla.
	object
ColumnType	string	El tipo de datos de la columna. Nota El valor devuelto de una columna no es único, como bigint o int.	bigint(1)
AutoIncrement	boolean	Indica si la columna es de incremento automático. Valores válidos: true: La columna es de incremento automático. false: La columna no es de incremento automático.	false
ColumnId	string	El ID de la columna.	63513****
ColumnName	string	El nombre de la columna.	has_promotion
SecurityLevel	string	El nivel de sensibilidad de la columna. Valores válidos: INNER: La columna no es sensible. SENSITIVE: La columna es sensible. CONFIDENTIAL: La columna es confidencial. Nota Para más información, consulte Niveles de sensibilidad de las columnas.	INNER
PrimaryKey	string	Indica si el campo es la clave principal. Valores válidos: true: El campo es la clave principal. false: El campo no es la clave principal.	true
Description	string	La descripción de la columna.	是否有优惠活动
DataPrecision	integer	La precisión del campo.	19
DataScale	integer	El número de decimales del campo.	0
Position	integer	La posición del campo en la tabla.	1
Nullable	boolean	Indica si el campo puede estar vacío. Valores válidos: true: El campo puede estar vacío. false: El campo no puede estar vacío.	false
DataLength	integer	La longitud del campo.	0
ErrorMessage	string	El mensaje de error devuelto.	TableGuid is mandatory for this action
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ErrorCode": "MissingTableGuid",
  "ColumnList": [
    {
      "ColumnType": "bigint(1)",
      "AutoIncrement": false,
      "ColumnId": "63513****",
      "ColumnName": "has_promotion",
      "SecurityLevel": "INNER",
      "PrimaryKey": "true",
      "Description": "Are there any promotions?",
      "DataPrecision": 19,
      "DataScale": 0,
      "Position": 1,
      "Nullable": false,
      "DataLength": 0
    }
  ],
  "ErrorMessage": "TableGuid is mandatory for this action.",
  "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.