ListColumns - Data Management - Alibaba Cloud Documentation Center

Returns the column information of a table.

Operation description

You can call this operation only for database instances whose control mode is Security Collaboration.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListColumns	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.	3***
TableId	string	Yes	The ID of the table. You can call the ListTables operation to obtain the table ID.	39281****
Logic	boolean	Yes	Specifies whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0AD9AC55-5873-474A-9F33-4285806A3619
ErrorCode	string	The error code returned.	UnknownError
ColumnList	array<object>	The details about columns.
Column	object	The details about fields in the table.
ColumnType	string	The data type of the column.	varchar
AutoIncrement	boolean	Indicates whether the column is an auto-increment column. Valid values: true: The column is an auto-increment column. false: The column is not an auto-increment column.	false
ColumnId	string	The ID of the column.	62589****
DefaultValue	string	The default value of the column.	def_value
Sensitive	boolean	Indicates whether the column is a sensitive column. Valid values: true: The column is a sensitive column. false: The column is not a sensitive column.	false
ColumnName	string	The name of the column.	name
SecurityLevel	string	The security level of the column. Valid values: INNER: The column is an internal column but not sensitive. SENSITIVE: The column is a sensitive column. CONFIDENTIAL: The column is a confidential column. Note For more information, see Sensitivity levels of fields.	INNER
Description	string	The description of the column.	test
DataPrecision	integer	The number of valid digits for the field.	0
DataScale	integer	The number of decimal places for the field.	0
FunctionType	string	The type of the masking algorithm that is used for the field. Valid values: null: No masking algorithm is used. DEFAULT: A full masking algorithm is used. FIX_POS: The fixed position is masked. FIX_CHAR: The fixed characters are replaced.	DEFAULT
Nullable	boolean	Indicates whether the column can be empty. Valid values: true: The column can be empty. false: The column cannot be empty.	false
DataLength	long	The length of the field.	4
ErrorMessage	string	The error message returned.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history