You can call this operation to query information such as columns and indexes of a table.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetMetaTableDetailInfo |
The operation that you want to perform. Valid values: GetMetaTableDetailInfo . |
TableGuid | String | Yes | IDB_L_9032.db-test.yuyang_test |
The GUID of the table in DMS. Note
|
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 |
---|---|---|---|
DetailInfo | Struct |
Details about the table. |
|
ColumnList | Array of Column |
The columns. |
|
AutoIncrement | Boolean | true |
Indicates whether the column is an auto-increment column. Valid values:
|
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, and Varchar. |
DataLength | Integer | 0 |
The length of the column. |
DataPrecision | Integer | 0 |
The precision of the column. |
DataScale | Integer | 0 |
The scale of the column. |
Description | String | test |
The description of the column. |
Nullable | Boolean | false |
Indicates whether the column is nullable. Valid values:
|
Position | String | 1 |
The position of the column in the table. |
IndexList | Array of Index |
The indexes. |
|
IndexColumns | List | id,name |
The index columns. |
IndexId | String | 123 |
The ID of the index. |
IndexName | String | PRIMARY |
The name of the index. |
IndexType | String | Primary |
The type of the index. Examples: Primary, Unique, and Normal. |
Unique | Boolean | false |
Indicates whether the index is unique. Valid values:
|
ErrorCode | String | UnknownError |
The error code returned. |
ErrorMessage | String | UnknownError |
The returned message. |
RequestId | String | E881CB2F-DE42-42E5-90EB-8B3173DCB9B9 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetMetaTableDetailInfo &TableGuid=IDB_L_9032.db-test.yuyang_test &<common request parameters>
Sample success responses
XML
format
<RequestId>E881CB2F-DE42-42E5-90EB-8B3173DCB9B9</RequestId> <DetailInfo> <ColumnList> <ColumnId>191234849</ColumnId> <ColumnName>id</ColumnName> <Description>test</Description> <ColumnType>bigint(20) unsigned</ColumnType> <Position>1</Position> <AutoIncrement>true</AutoIncrement> <DataScale>0</DataScale> <DataPrecision>20</DataPrecision> <Nullable>false</Nullable> </ColumnList> <ColumnList> <ColumnId>191234850</ColumnId> <ColumnName>gmt_create</ColumnName> <Description>test</Description> <ColumnType>datetime</ColumnType> <Position>2</Position> <AutoIncrement>false</AutoIncrement> <Nullable>false</Nullable> </ColumnList> <ColumnList> <ColumnId>191234851</ColumnId> <ColumnName>gmt_modified</ColumnName> <Description>test</Description> <ColumnType>datetime</ColumnType> <Position>3</Position> <AutoIncrement>false</AutoIncrement> <Nullable>false</Nullable> </ColumnList> <IndexList> <IndexName>PRIMARY</IndexName> <IndexId>33008763</IndexId> <IndexColumns>id</IndexColumns> <Unique>false</Unique> <IndexType>Primary</IndexType> </IndexList> </DetailInfo> <Success>true</Success>
JSON
Format
{ "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9", "DetailInfo": { "ColumnList": [ { "ColumnId": 191234849, "ColumnName": "id", "Description": "test", "ColumnType": "bigint(20) unsigned", "Position": 1, "AutoIncrement": true, "DataScale": 0, "DataPrecision": 20, "Nullable": false }, { "ColumnId": 191234850, "ColumnName": "gmt_create", "Description": "test", "ColumnType": "datetime", "Position": 2, "AutoIncrement": false, "Nullable": false }, { "ColumnId": 191234851, "ColumnName": "gmt_modified", "Description": "test", "ColumnType": "datetime", "Position": 3, "AutoIncrement": false, "Nullable": false } ], "IndexList": [ { "IndexName": "PRIMARY", "IndexId": 33008763, "IndexColumns": [ "id" ], "Unique": false, "IndexType": "Primary" } ] }, "Success": true }
Error codes
Go to the Error CenterFor more information, see error codes.