GetMetaTableColumn - Data Management - Alibaba Cloud Documentation Center

Queries the details of columns in 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:GetMetaTableColumn	get	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***
TableGuid	string	Yes	The globally unique identifier (GUID) of the table in Data Management (DMS). If the database to which the table belongs is a logical database, you can call the ListLogicTables operation to obtain the value of this parameter. If the database to which the table belongs is a physical database, you can call the ListTables operation to obtain the value of this parameter.	IDB_40753****.qntest2.activity_setting

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	087DFBA1-378B-5D25-B13B-31F6409F****
ErrorCode	string	The error code returned.	MissingTableGuid
ColumnList	array<object>	The details about fields in the table.
Column	object
ColumnType	string	The data type of the column. Note The return value of a column is not unique, such as bigint or int.	bigint(1)
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.	63513****
ColumnName	string	The name of the column.	has_promotion
SecurityLevel	string	The sensitivity level of the column. Valid values: INNER: The column is not sensitive. SENSITIVE: The column is sensitive. CONFIDENTIAL: The column is confidential. Note For more information, see Sensitivity levels of columns.	INNER
PrimaryKey	string	Indicates whether the field is the primary key. Valid values: true: The field is the primary key. false: The field is not the primary key.	true
Description	string	The description of the column.	Whether discounts are provided
DataPrecision	integer	The precision of the field.	19
DataScale	integer	The number of decimal places for the field.	0
Position	integer	The position of the field in the table.	1
Nullable	boolean	Indicates whether the field can be empty. Valid values: true: The field can be empty. false: The field cannot be empty.	false
DataLength	long	The length of the field.	0
ErrorMessage	string	The error message returned.	TableGuid is mandatory for this action.
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": "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ErrorCode": "MissingTableGuid",
  "ColumnList": [
    {
      "ColumnType": "bigint(1)",
      "AutoIncrement": false,
      "ColumnId": "63513****",
      "ColumnName": "has_promotion",
      "SecurityLevel": "INNER",
      "PrimaryKey": "true",
      "Description": "Whether discounts are provided\n",
      "DataPrecision": 19,
      "DataScale": 0,
      "Position": 1,
      "Nullable": false,
      "DataLength": 0
    }
  ],
  "ErrorMessage": "TableGuid is mandatory for this action.",
  "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