ListTableColumns - Data Management - Alibaba Cloud Documentation Center

Queries the details about fields in a table.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListTableColumns	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The tenant ID. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***
DbId	integer	Yes	The ID of a physical database: You can call the ListDatabases or SearchDatabase operation to obtain the physical database ID.	123
TableName	string	Yes	The table name. Note You can also call the ListTables operation to query the table name.	100g_customer
TableSchemaName	string	No	The schema name of the table, which is required only for SQL Server instances.	dbo

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned if the request failed.	UnknownError
ColumnList	array<object>	The details about fields in the table.
Column	object
ColumnId	string	The ID of the field.	12345
ColumnType	string	The data type of the field.	varchar
Description	string	The description of the field.	column desc
AutoIncrement	boolean	Indicates whether the field is an auto-increment field. Valid values: true: The field is an auto-increment field. false: The field is not an auto-increment field.	false
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.	NULL
DataPrecision	integer	The number of valid digits for the column.	0
DefaultValue	string	The default value of the column.	aaa
ColumnName	string	The field name.	c1
SecurityLevel	string	The security level of the field. Valid values: INNER: The field is an internal field but not sensitive. SENSITIVE: The field is sensitive. CONFIDENTIAL: The field is a confidential column.	INNER
DataScale	integer	The number of decimal places of the field data.	0
DataLength	long	The length of the field.	32
Sensitive	boolean	Indicates whether the field is a sensitive column. Valid values: true: The field is a sensitive field. false: The field is not a sensitive field.	false
Nullable	boolean	Indicates whether the field can be empty. Valid values: true: The field can be empty. false: The field cannot be empty.	true
ErrorMessage	string	The error message that is returned if the request failed.	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": "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
}

Error codes

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