DescribeRoleZoneInfo - - Centro de documentación de Alibaba Cloud

Esta operación permite consultar los roles y las zonas de los nodos en una instancia de ApsaraDB for MongoDB.

Nota

Para obtener más información, consulte

Esta operación solo aplica a instancias de conjunto de réplicas y clústeres con sharding; no es compatible con instancias independientes.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeRoleZoneInfo	La operación que desea ejecutar. Establezca el valor en DescribeRoleZoneInfo.
DBInstanceId	String	Sí	dds-bpxxxxxxxx	El ID de la instancia.
RegionId	String	No	cn-hangzhou	El ID de región de la instancia. Puede llamar a la operación DescribeRegions para consultar el ID de región de la instancia.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	728B9A96-E262-4AE5-915E-3A51CCE2FDA9	El ID de la solicitud.
ZoneInfos	Array		Matriz que contiene la información de los nodos en la zona.
ZoneInfo
InsName	String	dds-bpxxxxxxxx	El ID del nodo.
NodeType	String	normal	El tipo de nodo. Valores válidos: normal configServer shard mongos Nota Valor válido para instancias de conjunto de réplicas: normal. Valores válidos para instancias de clúster con sharding: configServer, shard y mongos.
RoleId	String	83xxxxx	El ID del rol.
RoleType	String	Primary	El rol del nodo. Valores válidos: Primary Secondary Hidden
ZoneId	String	cn-hangzhou-e	El ID de la zona.

Ejemplos

Solicitud de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<DescribeRoleZoneInfoResponse>
	  <ZoneInfos>
		    <ZoneInfo>
			      <RoleType>Primary</RoleType>
			      <NodeType>normal</NodeType>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-e</ZoneId>
			      <RoleId>83xxxxx</RoleId>
		    </ZoneInfo>
		    <ZoneInfo>
			      <RoleType>Secondary</RoleType>
			      <NodeType>normal</NodeType>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-f</ZoneId>
			      <RoleId>83xxxxx</RoleId>
		    </ZoneInfo>
		    <ZoneInfo>
			      <RoleType>Hidden</RoleType>
			      <NodeType>normal</NodeType>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-b</ZoneId>
			      <RoleId>83xxxxx</RoleId>
		    </ZoneInfo>
	  </ZoneInfos>
	  <RequestId>728B9A96-E262-4AE5-915E-3A51CCE2FDA9</RequestId>
</DescribeRoleZoneInfoResponse>

Formato JSON

{
	"ZoneInfos": {
		"ZoneInfo": [
			{
				"RoleType": "Primary",
				"NodeType": "normal",
				"InsName": "dds-bpxxxxxxxx",
				"ZoneId": "cn-hangzhou-e",
				"RoleId": "83xxxxx"
			},
			{
				"RoleType": "Secondary",
				"NodeType": "normal",
				"InsName": "dds-bpxxxxxxxx",
				"ZoneId": "cn-hangzhou-f",
				"RoleId": "83xxxxx"
			},
			{
				"RoleType": "Hidden",
				"NodeType": "normal",
				"InsName": "dds-bpxxxxxxxx",
				"ZoneId": "cn-hangzhou-b",
				"RoleId": "83xxxxx"
			}
		]
	},
	"RequestId": "728B9A96-E262-4AE5-915E-3A51CCE2FDA9"
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.