调用ListTables获取一个库下面的表详情列表
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListTables |
系统规定参数。取值:ListTables。 |
DatabaseId | String | 是 | 1 |
库ID |
PageNumber | Integer | 是 | 1 |
第几页 |
Tid | Long | 是 | -1 |
DMS企业版租户ID |
PageSize | Integer | 否 | 10 |
每页记录数 |
SearchName | String | 否 | test |
表关键字,前缀匹配 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码 |
ErrorMessage | String | UnknownError |
错误信息 |
RequestId | String | B16FB618-5E96-4FFD-BB0D-490C890A4030 |
请求ID |
Success | Boolean | true |
请求是否成功 |
TableList |
表详情列表 |
||
Table |
表详情列表 |
||
DatabaseId | String | 1 |
库ID |
Encoding | String | utf8 |
表编码 |
Engine | String | innodb |
表引擎 |
NumRows | Long | 1 |
表行数(统计值,非精确行数) |
OwnerIdList | 1 |
表Owner id列表 |
|
OwnerIds |
表Owner id列表 |
||
OwnerNameList | owner_name |
表Owner昵称列表 |
|
OwnerNames |
表Owner昵称列表 |
||
StoreCapacity | Long | 1024 |
表占用存储空间容量(统计值,非精确容量) |
TableId | String | 1 |
表ID |
TableName | String | test |
表名 |
TableSchemaName | String | test_db |
表所对应库名 |
TableType | String | NORMAL |
表类型,一般为NORMAL |
TotalCount | Long | 12 |
满足条件的表总个数 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListTables
&DatabaseId=1
&PageNumber=1
&Tid=-1
&<公共请求参数>
正常返回示例
XML
格式
<TableList>
<Table>
<TableSchemaName>xxx_test</TableSchemaName>
<OwnerNameList>
<OwnerNames>xxx</OwnerNames>
<OwnerNames>xxx[子账号]</OwnerNames>
</OwnerNameList>
<DatabaseId>116367</DatabaseId>
<Encoding>utf8mb4</Encoding>
<NumRows>3</NumRows>
<StoreCapacity>1</StoreCapacity>
<TableName>base_user</TableName>
<TableType>NORMAL</TableType>
<OwnerIdList>
<OwnerIds>88653</OwnerIds>
<OwnerIds>104442</OwnerIds>
</OwnerIdList>
<Engine>InnoDB</Engine>
<TableId>18396363</TableId>
</Table>
<Table>
<TableSchemaName>xxx_test</TableSchemaName>
<OwnerNameList>
<OwnerNames>xxx</OwnerNames>
<OwnerNames>xxx[子账号]</OwnerNames>
</OwnerNameList>
<DatabaseId>116367</DatabaseId>
<Encoding>utf8mb4</Encoding>
<NumRows>2</NumRows>
<StoreCapacity>1</StoreCapacity>
<TableName>biz_orders</TableName>
<TableType>NORMAL</TableType>
<OwnerIdList>
<OwnerIds>88653</OwnerIds>
<OwnerIds>104442</OwnerIds>
</OwnerIdList>
<Engine>InnoDB</Engine>
<TableId>18390459</TableId>
</Table>
</TableList>
<TotalCount>12</TotalCount>
<RequestId>B16FB618-5E96-4FFD-BB0D-490C890A4030</RequestId>
<Success>true</Success>
JSON
格式
{
"TableList":{
"Table":[
{
"TableSchemaName":"xxx_test",
"OwnerNameList":{
"OwnerNames":[
"xxx",
"xxx[子账号]"
]
},
"DatabaseId":116367,
"Encoding":"utf8mb4",
"NumRows":3,
"TableName":"base_user",
"StoreCapacity":1,
"TableType":"NORMAL",
"Engine":"InnoDB",
"OwnerIdList":{
"OwnerIds":[
88653,
104442
]
},
"TableId":18396363
},
{
"TableSchemaName":"xxx_test",
"OwnerNameList":{
"OwnerNames":[
"xxx",
"xxx[子账号]"
]
},
"DatabaseId":116367,
"Encoding":"utf8mb4",
"NumRows":2,
"TableName":"biz_orders",
"StoreCapacity":1,
"TableType":"NORMAL",
"Engine":"InnoDB",
"OwnerIdList":{
"OwnerIds":[
88653,
104442
]
},
"TableId":18390459
}
]
},
"TotalCount":12,
"RequestId":"B16FB618-5E96-4FFD-BB0D-490C890A4030",
"Success":true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交