调用ListTables获取一个库下面的表详情列表。
接口说明
仅管控模式为安全协同的数据库实例可调用此 API。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:ListTables | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。 | 3*** |
| DatabaseId | string | 是 | 物理库 ID，可通过调用接口 ListDatabases 或 SearchDatabase 获取该参数的值。 | 1860**** |
| PageNumber | integer | 是 | 第几页。 | 1 |
| PageSize | integer | 否 | 每页数据量。 | 10 |
| SearchName | string | 否 | 表搜索名，支持模糊搜索。 | test |
| ReturnGuid | boolean | 否 | 是否返回表的唯一识别码 GUID（Globally Unique Identifier），取值如下：
| true |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "B16FB618-5E96-4FFD-BB0D-490C890A4030",
"ErrorCode": "UnknownError",
"TableList": {
"Table": [
{
"DatabaseId": "1860****",
"TableName": "consumption_records",
"StoreCapacity": 1024,
"OwnerIdList": {
"OwnerIds": [
"51****"
]
},
"Description": "test",
"Encoding": "utf8",
"OwnerNameList": {
"OwnerNames": [
"owner_name"
]
},
"TableSchemaName": "qntest",
"TableType": "NORMAL",
"TableGuid": "IDB_44743****.qntest.consumption_records",
"Engine": "InnoDB",
"NumRows": 10085,
"TableId": "44743****"
}
]
},
"ErrorMessage": "UnknownError",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史