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

Use esta operação para consultar as informações de conexão de instâncias de cluster com sharding do ApsaraDB for MongoDB.

Esta operação é compatível apenas com instâncias de cluster com sharding.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeShardingNetworkAddress	A operação a ser executada. Defina o valor como DescribeShardingNetworkAddress.
DBInstanceId	String	Sim	dds-bpxxxxxxxx	O ID da instância.
NodeId	String	Não	d-bpxxxxxxxx	Uma instância de cluster com sharding consiste em três componentes: mongos, shard e Configserver. Nota Use a operação DescribeDBInstanceAttribute para consultar o ID do nó mongos, shard ou Configserver.
RegionId	String	Não	cn-hangzhou	O ID da região da instância. Para obter esse ID, use a operação DescribeRegions.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
CompatibleConnections	Array		Um array composto pelos endpoints das instâncias do DynamoDB.
CompatibleConnection
ExpiredTime	String	2591963	Tempo restante do endereço de rede clássica. Unidade: segundos.
IPAddress	String	10.140.xxx.xx	Endereço IP da instância.
NetworkAddress	String	dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com	Endpoint da instância.
NetworkType	String	VPC	Tipo de rede. Valores válidos: VPC Classic Public: endpoint público
Port	String	3717	Número da porta.
VPCId	String	vpc-bpxxxxxxxx	ID da VPC. Nota Este parâmetro é retornado quando o tipo de rede é VPC.
VswitchId	String	vsw-bpxxxxxxxx	ID do vSwitch da VPC. Nota Este parâmetro é retornado quando o tipo de rede é VPC.
NetworkAddresses	Array		Um array composto pelos endpoints das instâncias do ApsaraDB for MongoDB.
NetworkAddress
ExpiredTime	String	2591963	Tempo restante do endereço de rede clássica. Unidade: segundos.
IPAddress	String	10.140.xxx.xx	Endereço IP da instância.
NetworkAddress	String	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com	Endpoint da instância.
NetworkType	String	VPC	Tipo de rede. Valores válidos: VPC Classic Public: endpoint público
NodeId	String	s-bpxxxxxxxx	ID do mongos.
NodeType	String	mongos	Tipo do nó. Valores válidos: mongos shard configserver
Port	String	3717	Número da porta.
Role	String	Primary	Função do nó. Valores válidos: Primary Secondary
VPCId	String	vpc-bpxxxxxxxx	ID da VPC. Nota Este parâmetro é retornado quando o tipo de rede é VPC.
VswitchId	String	vsw-bpxxxxxxxx	ID do vSwitch da VPC. Nota Este parâmetro é retornado quando o tipo de rede é VPC.
RequestId	String	18D8AAFD-6BEB-420F-8164-810CB0C0AA39	ID da solicitação.

Exemplos

Exemplos de solicitações

http(s)://mongodb.aliyuncs.com/? Action=DescribeShardingNetworkAddress
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<NetworkAddresses>
    <NetworkAddress>
        <NetworkType>Public</NetworkType>
        <NodeId>s-bpxxxxxxxx</NodeId>
        <Port>3717</Port>
        <VPCId/>
        <IPAddress>47.xx.xx.xxx</IPAddress>
        <NodeType>mongos</NodeType>
        <Role>Primary</Role>
        <NetworkAddress>s-bpxxxxxxxx-pub.mongodb.rds.aliyuncs.com</NetworkAddress>
    </NetworkAddress>
    <NetworkAddress>
        <NetworkType>VPC</NetworkType>
        <NodeId>s-bpxxxxxxxx</NodeId>
        <Port>3717</Port>
        <VPCId>vpc-bpxxxxxxxx</VPCId>
        <IPAddress>192.168.xx.xxx</IPAddress>
        <NodeType>mongos</NodeType>
        <Role>Primary</Role>
        <VswitchId>vsw-bpxxxxxxxx</VswitchId>
        <NetworkAddress>s-bpxxxxxxxx.mongodb.rds.aliyuncs.com</NetworkAddress>
    </NetworkAddress>
</NetworkAddresses>
<RequestId>3F5DD5CD-0B93-46FF-96DD-F938B13CDE8B</RequestId>

Formato JSON

{
    "NetworkAddresses": {
        "NetworkAddress": [
            {
                "NetworkType": "Public",
                "NodeId": "s-bpxxxxxxxx",
                "Port": "3717",
                "VPCId": "",
                "IPAddress": "47.xx.xx.xxx",
                "NodeType": "mongos",
                "Role": "Primary",
                "NetworkAddress": "s-bpxxxxxxxx-pub.mongodb.rds.aliyuncs.com"
            },
            {
                "NetworkType": "VPC",
                "NodeId": "s-bpxxxxxxxx",
                "Port": "3717",
                "VPCId": "vpc-bpxxxxxxxx",
                "IPAddress": "192.168.xx.xxx",
                "NodeType": "mongos",
                "Role": "Primary",
                "VswitchId": "vsw-bpxxxxxxxx",
                "NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com"
            }
        ]
    },
    "RequestId": "3F5DD5CD-0B93-46FF-96DD-F938B13CDE8B"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.