GetDBTopology - - Centre de documentation Alibaba Cloud

Appelez l'opération GetDBTopology pour obtenir les informations de topologie de la base de données logique et de ses sous-bases de données physiques correspondantes.

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 de requête

Paramètre	Type	Obligatoire	Exemple	Description
LogicDbId	Long	Oui	134325	ID de la base de données logique. Remarque Vous pouvez appeler l'opération ListLogicDatabases pour récupérer ce paramètre.
Tid	Long	Non	43215	ID du locataire. Remarque Récupérez l'ID du locataire affiché dans le coin supérieur droit de la console. Pour plus d'informations, reportez-vous à la rubrique ID du locataire et locataire .
RegionId	String	Non	cn-hangzhou	Sélectionnez la région du service DMS pour appeler l'interface. Pour connaître les valeurs possibles, reportez-vous au paramètre RegionID . Remarque Définissez cette valeur sur l'ID de la région la plus proche de vos applications.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	C5B8E84B-42B6-4374-AD5A-6264E1753378	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé.
ErrorCode	String	UnknownError	Code d'erreur renvoyé.
DBTopology	object		Informations de topologie
LogicDbId	Long	1234	ID de la base de données logique.
LogicDbName	String	logic_db_test	Nom de la base de données logique.
SearchName	String	logic_db_test	Nom de recherche de la base de données logique.
Alias	String	logic_db_test	Alias de la base de données logique.
DbType	String	polardb	Type de base de données. Pour connaître les valeurs possibles, reportez-vous au paramètre DbType .
EnvType	String	dev	Type d'environnement. Les valeurs et descriptions pour la base de données logique sont les suivantes : product : environnement de production dev : environnement de développement pre : environnement de préproduction test : environnement de test sit : environnement SIT (System Integration Test) uat : environnement UAT (User Acceptance Test) pet : environnement de test de charge stag : environnement STAG Remarque Pour plus d'informations, reportez-vous à la rubrique Description de l'environnement de l'instance .
DBTopologyInfoList	Array of DBTopologyInfo		Liste des informations de topologie des shards de base de données.
DbId	Long	423532	ID de la base de données.
SchemaName	String	db_test@rm-xxx:3306	Schéma de la base de données PolarDB-X. Remarque Si le type de base de données est de la série PG, ce champ correspond au nom du mode PG.
CatalogName	String	def	Nom du catalogue de la base de données. Remarque Si le type de base de données est de la série PG, ce champ indique le nom de la base de données PG.
SearchName	String	db_test	Nom de recherche de la base de données.
DbType	String	polardb	Type de base de données. Pour connaître les valeurs possibles, reportez-vous au paramètre DbType .
EnvType	String	dev	Type d'environnement. Les valeurs et descriptions pour la base de données logique sont les suivantes : product : environnement de production dev : environnement de développement pre : environnement de préproduction test : environnement de test sit : environnement SIT (System Integration Test) uat : environnement UAT (User Acceptance Test) pet : environnement de test de charge stag : environnement STAG Remarque Pour plus d'informations, reportez-vous à la rubrique Description de l'environnement de l'instance .
InstanceId	Long	4325325	ID de l'instance Message Queue for Apache Kafka contenant le groupe de consommateurs.
RegionId	String	cn-hangzhou	Région à laquelle l'instance appartient.
InstanceResourceId	String	rm-xxx	ID de la ressource d'instance. Les valeurs possibles sont les suivantes : RDS : ID de l'instance de base de données Alibaba Cloud ECS_OWN : ID de l'instance ECS PUBLIC_OWN : vide VPC_ID : ID du VPC GATEWAY : ID de l'instance de passerelle de base de données
InstanceSource	String	RDS	Source de l'instance. Les valeurs possibles sont les suivantes : RDS : instance de base de données Alibaba Cloud ECS_OWN : instance de base de données auto-hébergée sur ECS PUBLIC_OWN : instance de base de données auto-hébergée sur Internet public VPC_ID : instance de base de données IDC via ligne dédiée VPC GATEWAY : instance de passerelle de base de données

Exemples

Exemple de requête


     http(s)://[Endpoint]/?LogicDbId=134325 &Tid=43215&Public request parameters

Exemple de réponse en cas de succès

XML format


     HTTP/1.1 200 OK Content-Type:application/xml <RequestId>C5B8E84B-42B6-4374-AD5A-6264E1753378</RequestId> <Success>true</Success> <ErrorMessage>UnknownError</ErrorMessage> <ErrorCode>UnknownError</ErrorCode> <DBTopology> <LogicDbId>1234</LogicDbId> <LogicDbName>logic_db_test</LogicDbName> <SearchName>logic_db_test</SearchName> <Alias>logic_db_test</Alias> <DbType>polardb</DbType> <EnvType>dev</EnvType> <DBTopologyInfoList> <DbId>423532</DbId> <SchemaName>db_test@rm-xxx:3306</SchemaName> <CatalogName>def</CatalogName> <SearchName>db_test</SearchName> <DbType>polardb</DbType> <EnvType>dev</EnvType> <InstanceId>4325325</InstanceId> <RegionId>cn-hangzhou</RegionId> <InstanceResourceId>rm-xxx</InstanceResourceId> <InstanceSource>RDS</InstanceSource> </DBTopologyInfoList> </DBTopology>

JSON format


     HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "C5B8E84B-42B6-4374-AD5A-6264E1753378", "Success" : true, "ErrorMessage" : "UnknownError", "ErrorCode" : "UnknownError", "DBTopology" : { "LogicDbId" : 1234, "LogicDbName" : "logic_db_test", "SearchName" : "logic_db_test", "Alias" : "logic_db_test", "DbType" : "polardb", "EnvType" : "dev", "DBTopologyInfoList" : [ { "DbId" : 423532, "SchemaName" : "db_test@rm-xxx:3306", "CatalogName" : "def", "SearchName" : "db_test", "DbType" : "polardb", "EnvType" : "dev", "InstanceId" : 4325325, "RegionId" : "cn-hangzhou", "InstanceResourceId" : "rm-xxx", "InstanceSource" : "RDS" } ] } }

Codes d'erreur

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