Call GetMetaTableColumn operation to obtain the field information of a table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetMetaTableColumn

The operation that you want to perform. Valid values: GetMetaTableColumn .

TableGuid String Yes IDB_L_11345.yuyang_test.base_user

The GUID of the table in DMS.

Note
  • Logical database: callable ListLogicTables Interface, you need to set the ReturnGuid parameter to true .
  • Physical Database: callable ListTables Interface, you need to set the ReturnGuid parameter to true .
Tid Long No 123

The tenant ID.

Note The tenant ID is taken from the avatar in the upper-right corner of the system. For more information, see Tenant ID and Tenant .
RegionId String No cn-hangzhou

Select a service region for DMS to call this operation. For more information about the valid values, see RegionID parameter .

Note Set the value to the ID of the region to which your applications are close.

Response parameters

Parameter Type Example Description
ColumnList Array of Column

The columns.

AutoIncrement Boolean true

Indicates whether the field auto-increment. Default value: false. Valid values:

  • true : Auto-increment.
  • false : does not auto-increment.
ColumnId String 191234849

The ID of the column.

ColumnName String id

The name of the column.

ColumnType String bigint(20) unsigned

The data type of the column. Examples: Bigint , Int , Varchar .

DataLength Integer 0

The length of the column.

DataPrecision Integer 0

The precision of the column.

DataScale Integer 0

The number of digits after decimal of the field.

Description String test

The description of the column.

Nullable Boolean false

Whether the field can be empty. Default value: false. Valid values:

  • true : empty is allowed.
  • false : empty is not allowed.
Position Integer 1

The sequence of the fields in the table.

PrimaryKey String true

Indicates whether the field is a primary key. Valid values:

  • true : the primary key.
  • false : non-primary key.
SecurityLevel String INNER

The security level of the field. Values are as follows:

  • INNER : internal (non-sensitive)
  • SENSITIVE : Sensitive
  • CONFIDENTIAL : Confidential
Note For more information, see Field security level .
ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The returned message.

RequestId String 2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests


     http(s)://dms-enterprise.aliyuncs.com/? Action=GetMetaTableColumn &TableGuid=IDB_L_11345.yuyang_test.base_user &<common request parameters> 
   

Sample success responses

XML format


     <GetMetaTableColumnResponse> <RequestId>2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2</RequestId> <ErrorCode>UnknownError</ErrorCode> <ColumnList> <ColumnId>191234849</ColumnId> <ColumnName>id</ColumnName> <Description>test</Description> <ColumnType>bigint(20) unsigned</ColumnType> <Position>1</Position> <AutoIncrement>true</AutoIncrement> <SecurityLevel>INNER</SecurityLevel> <DataScale>0</DataScale> <DataLength>0</DataLength> <DataPrecision>0</DataPrecision> <PrimaryKey>true</PrimaryKey> <Nullable>false</Nullable> </ColumnList> <ErrorMessage>UnknownError</ErrorMessage> <Success>true</Success> </GetMetaTableColumnResponse> 
   

JSON Format


     { "RequestId": "2B581A5E-D4FE-4F77-BADE-DD944D7BEBE2", "ErrorCode": "UnknownError", "ColumnList": [{ "ColumnId": "191234849", "ColumnName": "id", "Description": "test", "ColumnType": "bigint(20) unsigned", "Position": "1", "AutoIncrement": "true", "SecurityLevel": "INNER", "DataScale": "0", "DataLength": "0", "DataPrecision": "0", "PrimaryKey": "true", "Nullable": "false" }], "ErrorMessage": "UnknownError", "Success": "true" } 
   

Error codes

Go to the Error Center For more information, see error codes.