GetDBTopology - - Centro de documentación de Alibaba Cloud

Llame a la API GetDBTopology para obtener la información de topología de la biblioteca lógica y su subbiblioteca física correspondiente.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera de forma dinámica el código de ejemplo de la operación para distintos SDK.

Parámetro de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
LogicDbId	Long	Sí	134325	El ID de la biblioteca lógica. Nota Llame a la interfaz ListLogicDatabases para obtener este parámetro.
Tid	Long	No	43215	El ID del inquilino. Nota Tome la información del ID de inquilino que se muestra en la esquina superior derecha del sistema. Para más detalles, consulte ID de inquilino e inquilino .
RegionId	String	No	cn-hangzhou	Seleccione la región del servicio de DMS para llamar a la interfaz. Para conocer el valor, consulte Parámetro RegionID . Nota Establezca el valor con el ID de la región más cercana a sus aplicaciones.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	C5B8E84B-42B6-4374-AD5A-6264E1753378	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa.
ErrorMessage	String	UnknownError	El mensaje de error devuelto.
ErrorCode	String	UnknownError	El código de error devuelto.
DBTopology	object		Información de topología.
LogicDbId	Long	1234	El ID de la biblioteca lógica.
LogicDbName	String	logic_db_test	El nombre de la biblioteca lógica.
SearchName	String	logic_db_test	El nombre de búsqueda de la biblioteca lógica.
Alias	String	logic_db_test	El alias de la biblioteca lógica.
DbType	String	polardb	El tipo de base de datos. Consulte los valores en Parámetro DbType .
EnvType	String	dev	El tipo de entorno. Los valores y la descripción de la biblioteca lógica son los siguientes: product : entorno de producción dev : entorno de desarrollo pre : entorno de preproducción test : entorno de pruebas sit : entorno SIT uat : entorno UAT pet : entorno de pruebas de carga stag : entorno STAG Nota Para más información, consulte Descripción del entorno de la instancia .
DBTopologyInfoList	Array of DBTopologyInfo		La lista con la información de topología de los fragmentos de la base de datos.
DbId	Long	423532	El ID de la base de datos.
SchemaName	String	db_test@rm-xxx:3306	El esquema de la base de datos PolarDB-X. Nota Si el tipo de base de datos pertenece a la serie PG, aquí se indica el nombre del modo PG.
CatalogName	String	def	El nombre del directorio de la base de datos. Nota Si el tipo de base de datos pertenece a la serie PG, este campo indica el nombre de la base de datos PG.
SearchName	String	db_test	El nombre de búsqueda de la biblioteca.
DbType	String	polardb	El tipo de base de datos. Consulte los valores en Parámetro DbType .
EnvType	String	dev	El tipo de entorno. Los valores y la descripción de la biblioteca lógica son los siguientes: product : entorno de producción dev : entorno de desarrollo pre : entorno de preproducción test : entorno de pruebas sit : entorno SIT uat : entorno UAT pet : entorno de pruebas de carga stag : entorno STAG Nota Para más información, consulte Descripción del entorno de la instancia .
InstanceId	Long	4325325	El ID de la instancia de Message Queue for Apache Kafka que contiene el grupo de consumidores.
RegionId	String	cn-hangzhou	La región a la que pertenece la instancia.
InstanceResourceId	String	rm-xxx	El ID del recurso de la instancia. El valor es el siguiente: RDS: ID de la instancia de base de datos de Alibaba Cloud ECS_OWN: ID de la instancia ECS PUBLIC_OWN: vacío VPC_ID: ID de la VPC GATEWAY: ID de la instancia de puerta de enlace de base de datos
InstanceSource	String	RDS	El origen de la instancia. El valor es el siguiente: RDS : una instancia de base de datos de Alibaba Cloud ECS_OWN : una instancia de biblioteca autogestionada en ECS PUBLIC_OWN : una instancia de base de datos autogestionada en red pública VPC_ID : una instancia de base de datos de IDC con línea dedicada VPC GATEWAY : la instancia de puerta de enlace de base de datos

Ejemplos

Solicitudes de ejemplo

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

Respuestas de ejemplo exitosas

Formato XML

     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>

Formato JSON

     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" } ] } }

Código de error

Vaya al Centro de errores para consultar más códigos de error.