ListColumns - - Centro de documentación de Alibaba Cloud

Consulta los campos de una tabla.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListColumns	La operación que desea ejecutar. Establezca el valor en ListColumns.
Tid	Long	Sí	3***	El ID del inquilino. Llame a la operación GetUserActiveTenant para obtener el ID del inquilino.
TableId	String	Sí	39281****	El ID de la tabla. Llame a la operación ListTables para obtener el ID de la tabla.
Logic	Boolean	Sí	false	Especifica si la base de datos es lógica. Valores válidos: true: La base de datos es lógica. false: La base de datos es física.
RegionId	String	No	cn-hangzhou	El ID de la región donde está activado Data Management (DMS). Para más información, consulte Parámetro RegionID.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	0AD9AC55-5873-474A-9F33-4285806A3619	El ID de la solicitud.
ErrorCode	String	UnknownError	El código de error devuelto.
ColumnList	Array of Column		La información sobre las columnas devueltas.
Column
ColumnType	String	varchar	El tipo de datos del campo.
AutoIncrement	Boolean	false	Indica si el campo es de incremento automático. Valores válidos: true: El campo es de incremento automático. false: El campo no es de incremento automático.
ColumnId	String	62589****	El ID del campo.
DefaultValue	String	def_value	El valor predeterminado del campo.
Sensitive	Boolean	false	Indica si el campo es sensible. Valores válidos: true: El campo es sensible. false: El campo no es sensible.
ColumnName	String	name	El nombre del campo.
SecurityLevel	String	INNER	El nivel de seguridad del campo. Valores válidos: INNER: El campo es interno pero no sensible. SENSITIVE: El campo es sensible. CONFIDENTIAL: El campo es confidencial. Nota Para más información, consulte Ajustar el nivel de sensibilidad de uno o más campos.
Description	String	test	La descripción del campo.
DataPrecision	Integer	0	El número de dígitos válidos del campo.
DataScale	Integer	0	El número de decimales del campo.
FunctionType	String	DEFAULT	El tipo de algoritmo de enmascaramiento que se usa para el campo. Valores válidos: null: No se usa ningún algoritmo de enmascaramiento. DEFAULT: Se usa un algoritmo de enmascaramiento total. FIX_POS: Se enmascara la posición fija. FIX_CHAR: Se reemplazan los caracteres fijos.
Nullable	Boolean	false	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.
DataLength	Long	4	La longitud del campo.
ErrorMessage	String	UnknownError	El mensaje de error devuelto.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.

Ejemplos

Solicitud de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListColumns
&Tid=3***
&TableId=39281****
&Logic=false
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListColumnsResponse>
    <RequestId>0AD9AC55-5873-474A-9F33-4285806A3619</RequestId>
    <ColumnList>
        <ColumnId>62589****</ColumnId>
        <ColumnName>name</ColumnName>
        <Description/>
        <ColumnType>varchar(4)</ColumnType>
        <AutoIncrement>false</AutoIncrement>
        <SecurityLevel>INNER</SecurityLevel>
        <DataLength>4</DataLength>
        <Sensitive>false</Sensitive>
        <Nullable>false</Nullable>
    </ColumnList>
    <Success>true</Success>
</ListColumnsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ColumnList" : [ {
    "ColumnId" : "62589****",
    "ColumnName" : "name",
    "Description" : "",
    "ColumnType" : "varchar(4)",
    "AutoIncrement" : false,
    "SecurityLevel" : "INNER",
    "DataLength" : 4,
    "Sensitive" : false,
    "Nullable" : false
  } ],
  "Success" : true
}

Códigos de error

Para consultar una lista de códigos de error, visite el Centro de errores de API.