首页 数据管理 DMS API参考 API目录 库表元数据 ListTables - 获取数据库的表详情列表

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

调用ListTables获取一个库下面的表详情列表。

接口说明

仅管控模式为安全协同的数据库实例可调用此API。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListTablesRead
    全部资源

请求参数

名称类型必填描述示例值
Tidlong

租户ID,可通过调用接口GetUserActiveTenantListUserTenants获取该参数的值。

3***
DatabaseIdstring

物理库ID,可通过调用接口ListDatabasesSearchDatabase获取该参数的值。

1860****
PageNumberinteger

第几页。

1
PageSizeinteger

每页数据量。

10
SearchNamestring

表搜索名,支持模糊搜索。

test
ReturnGuidboolean

是否返回表的唯一识别码GUID(Globally Unique Identifier),取值如下:

  • true:返回表的GUID
  • false:不返回表的GUID
true

返回参数

名称类型描述示例值
object
TotalCountlong

满足条件的表总个数。

1
RequestIdstring

请求ID。

B16FB618-5E96-4FFD-BB0D-490C890A4030
ErrorCodestring

错误码。

UnknownError
TableListarray

表详情列表。

object
DatabaseIdstring

物理库ID。

1860****
TableNamestring

表名。

consumption_records
StoreCapacitylong

表占用存储空间容量(统计值,非精确容量),单位为MB。

1024
OwnerIdListarray

表Owner的用户ID列表。

string

表Owner的用户ID。

51****
Descriptionstring

表描述信息。

test
Encodingstring

表编码。

utf8
OwnerNameListarray

表Owner的用户昵称列表。

string

表Owner的用户昵称。

owner_name
TableSchemaNamestring

表所在的数据库。

qntest
TableTypestring

表类型,默认为NORMAL。

NORMAL
TableGuidstring

表在DMS中的唯一识别码GUID(Globally Unique Identifier)。

IDB_44743****.qntest.consumption_records
Enginestring

表引擎。

InnoDB
NumRowslong

表行数(统计值,非精确行数)。

10085
TableIdstring

表ID。

44743****
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • 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
}

错误码

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

阿里云首页 数据管理 相关技术圈