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

Devuelve la información 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:ListColumns

list

*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***
TableId	string	Sí	El ID de la tabla. Puede llamar a la operación ListTables para obtener el ID de la tabla.	39281****
Logic	boolean	No	Especifica si la base de datos es una base de datos lógica. Valores válidos: true: La base de datos es una base de datos lógica. false: La base de datos es una base de datos física.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	0AD9AC55-5873-474A-9F33-4285806A3619
ErrorCode	string	El código de error devuelto.	UnknownError
ColumnList	object
Column	array<object>	Los detalles de las columnas.
	object	Los detalles de los campos en la tabla.
ColumnType	string	El tipo de datos de la columna.	varchar
AutoIncrement	boolean	Indica si la columna es una columna de incremento automático. Valores válidos: true: La columna es una columna de incremento automático. false: La columna no es una columna de incremento automático.	false
ColumnId	string	El ID de la columna.	62589****
DefaultValue	string	El valor predeterminado de la columna.	def_value
Sensitive	boolean	Indica si la columna es una columna sensible. Valores válidos: true: La columna es una columna sensible. false: La columna no es una columna sensible.	false
ColumnName	string	El nombre de la columna.	name
SecurityLevel	string	El nivel de seguridad de la columna. Valores válidos: INNER: La columna es una columna interna, pero no sensible. SENSITIVE: La columna es una columna sensible. CONFIDENTIAL: La columna es una columna confidencial. Nota Para obtener más información, consulte Niveles de sensibilidad de los campos.	INNER
Description	string	La descripción de la columna.	test
DataPrecision	integer	El número de dígitos válidos para el campo.	0
DataScale	integer	El número de lugares decimales para el campo.	0
FunctionType	string	El tipo de algoritmo de enmascaramiento que se utiliza para el campo. Valores válidos: null: No se utiliza ningún algoritmo de enmascaramiento. DEFAULT: Se utiliza un algoritmo de enmascaramiento completo. FIX_POS: Se enmascara la posición fija. FIX_CHAR: Se reemplazan los caracteres fijos.	DEFAULT
Nullable	boolean	Indica si la columna puede estar vacía. Valores válidos: true: La columna puede estar vacía. false: La columna no puede estar vacía.	false
DataLength	integer	La longitud del campo.	4
ErrorMessage	string	El mensaje de error devuelto.	UnknownError
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": "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnType": "varchar",
        "AutoIncrement": false,
        "ColumnId": "62589****",
        "DefaultValue": "def_value",
        "Sensitive": false,
        "ColumnName": "name",
        "SecurityLevel": "INNER",
        "Description": "test",
        "DataPrecision": 0,
        "DataScale": 0,
        "FunctionType": "DEFAULT",
        "Nullable": false,
        "DataLength": 4
      }
    ]
  },
  "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.