ListTables - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListTables	Opération à effectuer. Définissez la valeur sur ListTables.
Tid	Long	Yes	3***	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant ou ListUserTenants pour obtenir cet ID.
DatabaseId	String	Yes	1860****	ID de la base de données physique. Appelez l'opération ListDatabases ou SearchDatabase pour obtenir cet ID.
PageNumber	Integer	Yes	1	Numéro de la page à renvoyer.
PageSize	Integer	No	10	Nombre d'éléments à renvoyer par page.
SearchName	String	No	test	Nom utilisé pour la recherche de tables. La recherche floue est prise en charge.
ReturnGuid	Boolean	No	true	Indique s'il faut renvoyer le GUID de la table. Valeurs possibles : true : renvoie le GUID de la table. false : ne renvoie pas le GUID de la table.
RegionId	String	No	cn-hangzhou	ID de la région où Data Management (DMS) est activé. Pour plus d'informations, consultez la rubrique Paramètre RegionID.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	Long	1	Nombre total de tables correspondant aux conditions de requête.
RequestId	String	B16FB618-5E96-4FFD-BB0D-490C890A4030	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé en cas d'échec de la requête.
TableList	Array of Table		Détails des tables.
Table
DatabaseId	String	1860****	ID de la base de données physique.
TableName	String	consumption_records	Nom de la table.
StoreCapacity	Long	1024	Espace de stockage occupé par la table. Il s'agit d'une valeur statistique qui n'indique pas l'espace exact. Unité : Mo.
OwnerIdList	Array of String	51****	ID des propriétaires de la table.
Description	String	test	Description de la table.
Encoding	String	utf8	Format d'encodage de la table.
OwnerNameList	Array of String	owner_name	Pseudonymes des propriétaires de la table.
TableSchemaName	String	qntest	Base de données dans laquelle réside la table.
TableType	String	NORMAL	Type de la table. Valeur par défaut : NORMAL.
TableGuid	String	IDB_44743****.qntest.consumption_records	GUID de la table dans DMS.
Engine	String	InnoDB	Moteur de la table.
NumRows	Long	10085	Nombre de lignes dans la table. Il s'agit d'une valeur statistique qui n'indique pas le nombre réel de lignes.
TableId	String	44743****	ID de la table.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé en cas d'échec de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : la requête a abouti. false : la requête a échoué.

Exemples

Exemple de requête

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

Exemple de réponse réussie

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

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

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs.