ListTableColumns - Query table column details | DMS API - Data Management

Queries the column details of a specified table in a database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListTableColumns

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. You can call GetUserActiveTenant or ListUserTenants to obtain this value.	3***
DbId	integer	Yes	The physical database ID. You can call ListDatabases or SearchDatabase to obtain this value.	123
TableName	string	Yes	The table name. Note You can call ListTables to query table names.	100g_customer
TableSchemaName	string	No	The table schema name. Required only for SQL Server instances.	dbo

Response elements

Element	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	object
Column	array<object>	The column details.
	object
ColumnId	string	The column ID.	12345
ColumnType	string	The column data type.	varchar
Description	string	The column description.	column desc
AutoIncrement	boolean	Indicates whether the column auto-increments. Valid values: true: The column auto-increments. false: The column does not auto-increment.	false
FunctionType	string	The masking algorithm type. Valid values: null: No masking. DEFAULT: Full masking. FIX_POS: Fixed-position masking. FIX_CHAR: Fixed-character replacement.	NULL
DataPrecision	integer	The numeric precision of the column.	0
DefaultValue	string	The default value of the column.	aaa
ColumnName	string	The column name.	c1
SecurityLevel	string	The security level of the column. Valid values: INNER: Internal data, not sensitive. SENSITIVE: Sensitive data. CONFIDENTIAL: Confidential data.	INNER
DataScale	integer	The decimal scale of the column.	0
DataLength	integer	The column length.	32
Sensitive	boolean	Indicates whether the column contains sensitive data. Valid values: true: The column is sensitive. false: The column is not sensitive.	false
Nullable	boolean	Indicates whether the column allows null values. Valid values: true: The column allows null values. false: The column does not allow null values.	true
ErrorMessage	string	The error message 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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.