DescribeShardingNetworkAddress - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Obtém as informações de conexão de uma instância de cluster sharded do MongoDB.

Descrição da operação

Esta API é destinada apenas a instâncias de cluster sharded.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:DescribeShardingNetworkAddress

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bpxxxxxxxx
NodeId	string	Não	O ID de um nó mongos, shard ou ConfigServer na instância de cluster sharded. Nota Você pode chamar a operação DescribeDBInstanceAttribute para consultar os IDs dos nós mongos, shard e ConfigServer.	d-bpxxxxxxxx
NetworkType	string	Não	O tipo de rede. Valores válidos: VPC: virtual private cloud. Classic: rede clássica. Public: rede pública.	VPC

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CompatibleConnections	object
CompatibleConnection	array<object>	Detalhes de conexão para instâncias compatíveis com o protocolo DynamoDB.
	object
VswitchId	string	The ID of the vSwitch in the VPC. Nota This parameter is returned only when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining validity period of the classic network address that is retained, in seconds.	2591963
NetworkType	string	The network type. Valid values: VPC: a virtual private cloud. Classic: classic network. Public: public network.	VPC
Port	string	The port that is used to connect to the instance.	3717
NetworkAddress	string	The endpoint of the instance.	dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com
VPCId	string	The VPC ID. Nota This parameter is returned only when the network type is VPC.	vpc-bpxxxxxxxx
IPAddress	string	The IP address of the instance.	10.140.xxx.xx
RequestId	string	O ID da solicitação.	18D8AAFD-6BEB-420F-8164-810CB0C0AA39
NetworkAddresses	object
NetworkAddress	array<object>	Detalhes de conexão para instâncias que usam o protocolo MongoDB.
	object
NodeType	string	The type of the node. Valid values: mongos: a mongos node. shard: a shard node. configserver: a config server node.	mongos
VswitchId	string	The ID of the vSwitch in the VPC. Nota This parameter is returned only when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining validity period of the classic network address that is retained, in seconds.	2591963
NetworkType	string	The network type. Valid values: VPC: a virtual private cloud. Classic: classic network. Public: public network.	VPC
Role	string	The role of the node. Valid values: Primary: a primary node. Secondary: secondary node.	Primary
Port	string	The port that is used to connect to the instance.	3717
VPCId	string	The VPC ID. Nota This parameter is returned only when the network type is VPC.	vpc-bpxxxxxxxx
NetworkAddress	string	The endpoint of the node.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NodeId	string	The ID of the mongos or shard node.	s-bpxxxxxxxx
IPAddress	string	The IP address of the node.	10.140.xxx.xx
ConnectionType	string	The type of the public endpoint. Valid values: SRV Normal	SRV
TxtRecord	string	The TXT record. A TXT record is a type of Domain Name System (DNS) record that is used to store text-based information about a domain. It can be used to deliver service configurations and discover services by working with other technologies such as SRV records.	mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
ConnectionStringSuffix	string	O sufixo da string de conexão.	.mongodb.rds.aliyuncs.com

Exemplos

Resposta de sucesso

JSON formato

{
  "CompatibleConnections": {
    "CompatibleConnection": [
      {
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Port": "3717",
        "NetworkAddress": "dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com",
        "VPCId": "vpc-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx"
      }
    ]
  },
  "RequestId": "18D8AAFD-6BEB-420F-8164-810CB0C0AA39",
  "NetworkAddresses": {
    "NetworkAddress": [
      {
        "NodeType": "mongos",
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Role": "Primary",
        "Port": "3717",
        "VPCId": "vpc-bpxxxxxxxx",
        "NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NodeId": "s-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx",
        "ConnectionType": "SRV",
        "TxtRecord": "mongo.example.com. IN TXT \"config=replicaSet=myReplicaSet\""
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.