调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetMetaTableDetailInfo |
系统规定参数。取值:GetMetaTableDetailInfo。 |
TableGuid | String | 是 | IDB_L_9032.db-test.yuyang_test |
表在DMS中的唯一识别码GUID(Globally Unique Identifier)。 说明
|
Tid | Long | 否 | 123 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
RegionId | String | 否 | cn-hangzhou |
选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明。 说明 请根据应用所在地就近选择。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DetailInfo | Struct |
表详情。 |
|
ColumnList | Array of Column |
字段列表。 |
|
AutoIncrement | Boolean | true |
当前字段是否自增。取值:
|
ColumnId | String | 191234849 |
字段ID。 |
ColumnName | String | id |
字段名。 |
ColumnType | String | bigint(20) unsigned |
字段的数据类型。例如:Bigint 、Int、Varchar。 |
DataLength | Integer | 0 |
字段长度。 |
DataPrecision | Integer | 0 |
字段精度。 |
DataScale | Integer | 0 |
该字段小数后的位数。 |
Description | String | test |
字段描述。 |
Nullable | Boolean | false |
是否可空。取值:
|
Position | String | 1 |
字段在表中的顺序。 |
IndexList | Array of Index |
索引列表。 |
|
IndexColumns | List | id,name |
索引字段。 |
IndexId | String | 123 |
索引ID。 |
IndexName | String | PRIMARY |
索引名。 |
IndexType | String | Primary |
索引类型。例如:Primary、Unique、Normal。 |
Unique | Boolean | false |
是否为唯一索引。取值:
|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
RequestId | String | E881CB2F-DE42-42E5-90EB-8B3173DCB9B9 |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetMetaTableDetailInfo
&TableGuid=IDB_L_9032.db-test.yuyang_test
&<公共请求参数>
正常返回示例
XML
格式
<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
格式
{
"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
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交