GetDBTopology - : Central de Documentação do Alibaba Cloud

Chame a API GetDBTopology para obter as informações de topologia do banco de dados lógico e seus sub-bancos físicos correspondentes.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
LogicDbId	Long	Sim	134325	O ID do banco de dados lógico. Nota Você pode chamar a API ListLogicDatabases para obter este parâmetro.
Tid	Long	Não	43215	O ID do tenant. Nota Obtenha as informações do ID do tenant exibidas no canto superior direito do sistema. Para mais detalhes, consulte ID do Tenant e Tenant.
RegionId	String	Não	cn-hangzhou	Selecione a região de serviço do DMS para chamar a API. Para obter o valor, consulte Parâmetro RegionID. Nota Defina o valor como o ID da região mais próxima das suas aplicações.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	C5B8E84B-42B6-4374-AD5A-6264E1753378	O ID da requisição.
Success	Boolean	true	Indica se a requisição foi bem-sucedida.
ErrorMessage	String	UnknownError	A mensagem de erro retornada.
ErrorCode	String	UnknownError	O código de erro retornado.
DBTopology	object		Informações de topologia
LogicDbId	Long	1234	O ID do banco de dados lógico.
LogicDbName	String	logic_db_test	O nome do banco de dados lógico.
SearchName	String	logic_db_test	O nome de busca do banco de dados lógico.
Alias	String	logic_db_test	O alias do banco de dados lógico.
DbType	String	polardb	Tipo de banco de dados. Consulte os valores válidos em Parâmetro DbType.
EnvType	String	dev	O tipo de ambiente do banco de dados lógico possui os seguintes valores e descrições: product: ambiente de produção dev: ambiente de desenvolvimento pre: ambiente de staging test: ambiente de teste sit: ambiente SIT uat: ambiente UAT pet: ambiente de teste de carga stag: ambiente STAG Nota Para mais informações, consulte Descrição do ambiente da instância.
DBTopologyInfoList	Array of DBTopologyInfo		A lista de informações de topologia dos shards do banco de dados.
DbId	Long	423532	O ID do banco de dados.
SchemaName	String	db_test@rm-xxx:3306	O schema do banco de dados PolarDB-X. Nota Se o tipo de banco de dados for da série PG, este campo representa o nome do modo PG.
CatalogName	String	def	O nome do diretório do banco de dados. Nota Se o tipo de banco de dados for da série PG, este campo indica o nome do banco de dados PG.
SearchName	String	db_test	O nome de busca do banco de dados.
DbType	String	polardb	Tipo de banco de dados. Consulte os valores válidos em Parâmetro DbType.
EnvType	String	dev	O tipo de ambiente do banco de dados lógico possui os seguintes valores e descrições: product: ambiente de produção dev: ambiente de desenvolvimento pre: ambiente de staging test: ambiente de teste sit: ambiente SIT uat: ambiente UAT pet: ambiente de teste de carga stag: ambiente STAG Nota Para mais informações, consulte Descrição do ambiente da instância.
InstanceId	Long	4325325	O ID da instância que contém o banco de dados.
RegionId	String	cn-hangzhou	A região à qual a instância pertence.
InstanceResourceId	String	rm-xxx	O ID do recurso da instância. Os valores são: RDS: ID da instância de banco de dados Alibaba Cloud ECS_OWN: ID da instância ECS PUBLIC_OWN: vazio VPC_ID: ID da VPC GATEWAY: ID da instância do gateway de banco de dados
InstanceSource	String	RDS	A source da instância. Os valores são: RDS: instância de banco de dados Alibaba Cloud ECS_OWN: instância de banco de dados auto-hospedado em ECS PUBLIC_OWN: instância de banco de dados auto-hospedado em rede pública VPC_ID: instância de banco de dados IDC via linha dedicada VPC GATEWAY: instância do gateway de banco de dados

Exemplos

Exemplos de requisições


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

Exemplos de respostas de sucesso

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ódigos de erro

Acesse o Centro de Erros para consultar mais códigos de erro.