GetTableDBTopology - - Centre de documentation Alibaba Cloud

Utilisez l'interface GetTableDBTopology pour obtenir le diagramme de topologie de la table de données.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres

Paramètre	Type	Obligatoire	Exemple	Description
Tid	Long	Non	1	ID du locataire. Remarque Récupérez l'ID du locataire affiché dans le coin supérieur droit du système. Pour plus de détails, consultez Afficher les informations du locataire .
TableGuid	String	Oui	IDB_L_9032.db-test.yuyang_test	Identifiant unique GUID (Globally Unique Identifier) de la table dans DMS. Remarque Base de données logique : récupérable via l'interface ListLogicTables ; définissez le paramètre ReturnGuid sur true. Base de données physique : récupérable via l'interface ListTables ; définissez le paramètre ReturnGuid sur true.
RegionId	String	Non	cn-hangzhou	Sélectionnez la région de service DMS pour appeler l'interface. Pour connaître la valeur, consultez la description du paramètre RegionID . Remarque Sélectionnez la région la plus proche en fonction de l'emplacement de l'application.

Données de retour

Paramètre	Type	Exemple	Description
RequestId	String	853F7FD4-D922-4EFB-931C-D253EF159E06	ID de la requête.
DBTopology	object		Informations sur la topologie de la base de données.
TableName	String	yuyang_test	Nom de la table. Remarque Si vous interrogez une table logique, le nom de la table logique est renvoyé. Si vous interrogez une table physique, le nom de la table physique est renvoyé.
DataSourceList	Array of DataSource		Liste des sources de données.
Sid	String	def	SID de la source de données.
Host	String	xxx.mysql.polardb.rds.aliyuncs.com	Adresse de connexion de la source de données.
DbType	String	MySQL	Type de base de données. Reportez-vous à la description du paramètre DbType .
DatabaseList	Array of Database		Liste des partitions physiques.
DbId	String	489347	ID de la base de données.
DbName	String	db-test	Nom de la base de données physique.
DbType	String	MySQL	Type de base de données. Reportez-vous à la description du paramètre DbType .
TableList	Array of Table		Liste des partitions de tables physiques.
TableName	String	151977812	ID de la table.
TableType	String	yuyang_test_0000	Nom de la table physique.
TableId	String	NORMAL	Type de table, champs réservés.
EnvType	String	pre	Type d'environnement. Les valeurs et descriptions sont les suivantes : product : environnement de production dev : environnement de développement pre : environnement de préproduction test : environnement de test sit : environnement SIT uat : environnement UAT pet : environnement de test de charge stag : environnement STAG Remarque Pour plus d'informations, consultez la description de l'environnement de l'instance .
Port	Integer	3306	Port de connexion de la source de données.
TableGuid	String	IDB_L_9032.db-test.yuyang_test	Identifiant unique GUID (Globally Unique Identifier) de la table dans DMS.
ErrorCode	String	UnknownError	Code d'erreur.
ErrorMessage	String	UnknownError	Message d'erreur.
Success	Boolean	true	Indique si la requête a abouti.

Exemples

Exemple de requête


     http(s)://dms-enterprise.aliyuncs.com/? Tid=1 &TableGuid=IDB_L_9032.db-test.yuyang_test&public request parameters

Exemple de réponse réussie

XML Format


     HTTP/1.1 200 OK Content-Type:application/xml <GetTableDBTopologyResponse> <RequestId>78F78156-2BBE-414A-8A9D-BE61CF6FA60F</RequestId> <DBTopology> <TableName>big_table</TableName> <TableGuid>IDB_270000001.film.big_table</TableGuid> <DataSourceList> <DatabaseList> <DbId>4000000</DbId> <DbName>film</DbName> <TableList> <TableId>200000000</TableId> <TableName>big_table</TableName> <TableType>NORMAL</TableType> </TableList> <EnvType>product</EnvType> <DbType>mysql</DbType> </DatabaseList> <Port>3306</Port> <Host>rm-uf000000z0000002l.mysql.rds.aliyuncs.com</Host> <DbType>mysql</DbType> </DataSourceList> </DBTopology> <Success>true</Success> </GetTableDBTopologyResponse>

JSON Format


     HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "78F78156-2BBE-414A-8A9D-BE61CF6FA60F", "DBTopology" : { "TableName" : "big_table", "TableGuid" : "IDB_270000001.film.big_table", "DataSourceList" : [ { "DatabaseList" : [ { "DbId" : 4000000, "DbName" : "film", "TableList" : [ { "TableId" : 200000000, "TableName" : "big_table", "TableType" : "NORMAL" } ], "EnvType" : "product", "DbType" : "mysql" } ], "Port" : 3306, "Host" : "rm-uf000000z0000002l.mysql.rds.aliyuncs.com", "DbType" : "mysql" } ] }, "Success" : true }

Code d'erreur

Accédez au Centre d'erreurs pour consulter d'autres codes d'erreur.