调用ListTables接口获取物理库的表详情列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTables

系统规定参数。取值:ListTables

Tid Long 3***

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

DatabaseId String 1860****

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

PageNumber Integer 1

第几页。

PageSize Integer 10

每页数据量。

SearchName String test

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

ReturnGuid Boolean true

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

  • true:返回表的GUID
  • false:不返回表的GUID
RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
TotalCount Long 1

满足条件的表总个数。

RequestId String B16FB618-5E96-4FFD-BB0D-490C890A4030

请求ID。

ErrorCode String UnknownError

错误码。

TableList Array of Table

表详情列表。

Table
DatabaseId String 1860****

物理库ID。

TableName String consumption_records

表名。

StoreCapacity Long 1024

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

OwnerIdList Array of String 51****

表Owner的用户ID列表。

Description String test

表描述信息。

Encoding String utf8

表编码。

OwnerNameList Array of String owner_name

表Owner的用户昵称列表。

TableSchemaName String qntest

表所在的数据库。

TableType String NORMAL

表类型,默认为NORMAL。

TableGuid String IDB_44743****.qntest.consumption_records

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

Engine String InnoDB

表引擎。

NumRows Long 10085

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

TableId String 44743****

表ID。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

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

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTables
&Tid=3***
&DatabaseId=1860****
&PageNumber=1
&PageSize=10
&SearchName=test
&ReturnGuid=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTablesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>B16FB618-5E96-4FFD-BB0D-490C890A4030</RequestId>
    <TableList>
        <DatabaseId>1860****</DatabaseId>
        <TableName>consumption_records</TableName>
        <StoreCapacity>1024</StoreCapacity>
        <OwnerIdList>51****</OwnerIdList>
        <Description>test</Description>
        <Encoding>utf8</Encoding>
        <OwnerNameList>owner_name</OwnerNameList>
        <TableSchemaName>qntest</TableSchemaName>
        <TableType>NORMAL</TableType>
        <TableGuid>IDB_44743****.qntest.consumption_records</TableGuid>
        <Engine>InnoDB</Engine>
        <NumRows>10085</NumRows>
        <TableId>44743****</TableId>
    </TableList>
    <Success>true</Success>
</ListTablesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "B16FB618-5E96-4FFD-BB0D-490C890A4030",
  "TableList" : [ {
    "DatabaseId" : "1860****",
    "TableName" : "consumption_records",
    "StoreCapacity" : 1024,
    "OwnerIdList" : [ "51****" ],
    "Description" : "test",
    "Encoding" : "utf8",
    "OwnerNameList" : [ "owner_name" ],
    "TableSchemaName" : "qntest",
    "TableType" : "NORMAL",
    "TableGuid" : "IDB_44743****.qntest.consumption_records",
    "Engine" : "InnoDB",
    "NumRows" : 10085,
    "TableId" : "44743****"
  } ],
  "Success" : true
}

错误码

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