ListTables - - Centro de documentación de Alibaba Cloud

Consulta los detalles de las tablas en una base de datos física.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListTables	La operación que desea ejecutar. Establezca el valor en ListTables.
Tid	Long	Sí	3***	El ID del inquilino. Llame a la operación GetUserActiveTenant o ListUserTenants para obtener el ID del inquilino.
DatabaseId	String	Sí	1860****	El ID de la base de datos física. Llame a la operación ListDatabases o SearchDatabase para obtener el ID de la base de datos física.
PageNumber	Integer	Sí	1	El número de página que se devolverá.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página.
SearchName	String	No	test	El nombre utilizado para buscar tablas. Se admite la búsqueda difusa.
ReturnGuid	Boolean	No	true	Especifica si se debe devolver el GUID de una tabla. Valores válidos: true: devuelve el GUID de una tabla. false: no devuelve el GUID de una tabla.
RegionId	String	No	cn-hangzhou	El ID de la región donde está activado Data Management (DMS). Para más información, consulte Parámetro RegionID.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TotalCount	Long	1	El número total de tablas que cumplen con las condiciones de consulta.
RequestId	String	B16FB618-5E96-4FFD-BB0D-490C890A4030	El ID de la solicitud.
ErrorCode	String	UnknownError	El código de error que se devuelve si la solicitud falla.
TableList	Array of Table		Los detalles de las tablas.
Table
DatabaseId	String	1860****	El ID de la base de datos física.
TableName	String	consumption_records	El nombre de la tabla.
StoreCapacity	Long	1024	El espacio de almacenamiento ocupado por la tabla. Este es un valor estadístico y no indica el espacio de almacenamiento exacto. Unidad: MB.
OwnerIdList	Array of String	51****	Los IDs de los propietarios de la tabla.
Description	String	test	La descripción de la tabla.
Encoding	String	utf8	El formato de codificación de la tabla.
OwnerNameList	Array of String	owner_name	Los apodos de los propietarios de la tabla.
TableSchemaName	String	qntest	La base de datos en la que reside la tabla.
TableType	String	NORMAL	El tipo de la tabla. Valor predeterminado: NORMAL.
TableGuid	String	IDB_44743****.qntest.consumption_records	El GUID de la tabla en DMS.
Engine	String	InnoDB	El motor de la tabla.
NumRows	Long	10085	El número de filas en la tabla. Este es un valor estadístico y no indica el número real de filas.
TableId	String	44743****	El ID de la tabla.
ErrorMessage	String	UnknownError	El mensaje de error devuelto si la solicitud falla.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.

Ejemplos

Solicitudes de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTables
&Tid=3***
&DatabaseId=1860****
&PageNumber=1
&PageSize=10
&SearchName=test
&ReturnGuid=true
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato 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>

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

Código de error

Para consultar una lista de códigos de error, visite el Centro de errores.