DescribeShardingNetworkAddress - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Obtiene la información de conexión de una instancia de clúster fragmentado de MongoDB.

Descripción de la operación

Esta API es exclusiva para instancias de clúster fragmentado.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dds:DescribeShardingNetworkAddress

get

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-bpxxxxxxxx
NodeId	string	No	El ID de un nodo mongos, shard o ConfigServer en la instancia de clúster fragmentado. Nota Puede llamar a la operación DescribeDBInstanceAttribute para consultar los ID de los nodos mongos, shard y ConfigServer.	d-bpxxxxxxxx
NetworkType	string	No	El tipo de red. Valores válidos: VPC: nube privada virtual. Classic: red clásica. Public: red pública.	VPC

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
CompatibleConnections	object
CompatibleConnection	array<object>	Detalles de conexión para instancias compatibles con el protocolo DynamoDB.
	object
VswitchId	string	El ID del vSwitch en la VPC. Nota Este parámetro se devuelve solo cuando el tipo de red es VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	El período de validez restante de la dirección de red clásica que se conserva, en segundos.	2591963
NetworkType	string	El tipo de red. Valores válidos: VPC: una nube privada virtual. Classic: red clásica. Public: red pública.	VPC
Port	string	El puerto que se utiliza para conectarse a la instancia.	3717
NetworkAddress	string	El endpoint de la instancia.	dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com
VPCId	string	El ID de la VPC. Nota Este parámetro se devuelve solo cuando el tipo de red es VPC.	vpc-bpxxxxxxxx
IPAddress	string	La dirección IP de la instancia.	10.140.xxx.xx
RequestId	string	El ID de la solicitud.	18D8AAFD-6BEB-420F-8164-810CB0C0AA39
NetworkAddresses	object
NetworkAddress	array<object>	Detalles de conexión para instancias que utilizan el protocolo MongoDB.
	object
NodeType	string	El tipo de nodo. Valores válidos: mongos: un nodo mongos. shard: un nodo shard. configserver: un nodo config server.	mongos
VswitchId	string	El ID del vSwitch en la VPC. Nota Este parámetro se devuelve solo cuando el tipo de red es VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	El período de validez restante de la dirección de red clásica que se conserva, en segundos.	2591963
NetworkType	string	El tipo de red. Valores válidos: VPC: una nube privada virtual. Classic: red clásica. Public: red pública.	VPC
Role	string	El rol del nodo. Valores válidos: Primary: un nodo primario. Secondary: nodo secundario.	Primary
Port	string	El puerto que se utiliza para conectarse a la instancia.	3717
VPCId	string	El ID de la VPC. Nota Este parámetro se devuelve solo cuando el tipo de red es VPC.	vpc-bpxxxxxxxx
NetworkAddress	string	The endpoint of the node.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NodeId	string	El ID del nodo mongos o shard.	s-bpxxxxxxxx
IPAddress	string	La dirección IP del nodo.	10.140.xxx.xx
ConnectionType	string	El tipo de endpoint público. Valores válidos: SRV Normal	SRV
TxtRecord	string	El registro TXT. Un registro TXT es un tipo de registro del Sistema de Nombres de Dominio (DNS) que se utiliza para almacenar información basada en texto sobre un dominio. Se puede utilizar para entregar configuraciones de servicio y descubrir servicios al trabajar con otras tecnologías como los registros SRV.	mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
ConnectionStringSuffix	string	El sufijo de la cadena de conexión.	.mongodb.rds.aliyuncs.com

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.