ListTables - 获取数据库的表详情列表 - 数据管理 DMS

调用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：返回表的 GUID false：不返回表的 GUID	true

返回参数

名称	类型	描述	示例值
	object
TotalCount	long	满足条件的表总个数。	1
RequestId	string	请求 ID。	B16FB618-5E96-4FFD-BB0D-490C890A4030
ErrorCode	string	错误码。	UnknownError
TableList	array<object>	表详情列表。
Table	object
DatabaseId	string	物理库 ID。	1860****
TableName	string	表名。	consumption_records
StoreCapacity	long	表占用存储空间容量（统计值，非精确容量），单位为 MB。	1024
OwnerIdList	array	表 Owner 的用户 ID 列表。
OwnerIds	string	表 Owner 的用户 ID。	51****
Description	string	表描述信息。	test
Encoding	string	表编码。	utf8
OwnerNameList	array	表 Owner 的用户昵称列表。
OwnerNames	string	表 Owner 的用户昵称。	owner_name
TableSchemaName	string	表所在的数据库。	qntest
TableType	string	表类型，默认为 NORMAL。	NORMAL
TableGuid	string	表在 DMS 中的唯一识别码 GUID（Globally Unique Identifier）。	IDB_44743****.qntest.consumption_records
Engine	string	表引擎。	InnoDB
NumRows	long	表行数（统计值，非精确行数）。	10085
TableId	string	表 ID。	44743****
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史