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

Consulta los detalles de los campos de una tabla.

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

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 o ListUserTenants para obtener el ID del inquilino.	3***
DbId	integer	Sí	El ID de una base de datos física: puede llamar a la operación ListDatabases o SearchDatabase para obtener el ID de la base de datos física.	123
TableName	string	Sí	El nombre de la tabla. Nota También puede llamar a la operación ListTables para consultar el nombre de la tabla.	100g_customer
TableSchemaName	string	No	El nombre del esquema de la tabla, que es necesario solo para instancias de SQL Server.	dbo

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ColumnList	object
Column	array<object>	Los detalles de los campos de la tabla.
	object
ColumnId	string	El ID del campo.	12345
ColumnType	string	El tipo de datos del campo.	varchar
Description	string	La descripción del campo.	column desc
AutoIncrement	boolean	Indica si el campo es un campo de incremento automático. Valores válidos: true: el campo es un campo de incremento automático. false: el campo no es un campo de incremento automático.	false
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.	NULL
DataPrecision	integer	El número de dígitos válidos para la columna.	0
DefaultValue	string	El valor predeterminado de la columna.	aaa
ColumnName	string	El nombre del campo.	c1
SecurityLevel	string	El nivel de seguridad del campo. Valores válidos: INNER: el campo es un campo interno pero no sensible. SENSITIVE: el campo es sensible. CONFIDENTIAL: el campo es una columna confidencial.	INNER
DataScale	integer	El número de decimales de los datos del campo.	0
DataLength	integer	La longitud del campo.	32
Sensitive	boolean	Indica si el campo es una columna sensible. Valores válidos: true: el campo es un campo sensible. false: el campo no es un campo sensible.	false
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.	true
ErrorMessage	string	El mensaje de error que se devuelve si la solicitud falló.	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": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnId": "12345",
        "ColumnType": "varchar",
        "Description": "column desc",
        "AutoIncrement": false,
        "FunctionType": "NULL",
        "DataPrecision": 0,
        "DefaultValue": "aaa",
        "ColumnName": "c1",
        "SecurityLevel": "INNER",
        "DataScale": 0,
        "DataLength": 32,
        "Sensitive": false,
        "Nullable": true
      }
    ]
  },
  "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.