Tous les produits
Search
Centre de documentation

:DescribeRoleZoneInfo

Dernière mise à jour :Aug 08, 2026

Appelez cette opération pour interroger les rôles et les zones des nœuds d'une instance ApsaraDB for MongoDB.

Remarque

Pour plus d'informations, consultez

View the zone of a node

.

Cette opération s'applique uniquement aux instances de type Replica Set et Sharded Cluster, mais pas aux instances Standalone.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

Action

String

Oui

DescribeRoleZoneInfo

Opération à effectuer. Définissez la valeur sur DescribeRoleZoneInfo.

DBInstanceId

String

Oui

dds-bpxxxxxxxx

ID de l'instance.

RegionId

String

Non

cn-hangzhou

ID de la région de l'instance. Appelez l'opération DescribeRegions pour interroger l'ID de la région de l'instance.

Paramètres de réponse

Paramètre Type Exemple Description
RequestId String 728B9A96-E262-4AE5-915E-3A51CCE2FDA9

ID de la requête.

ZoneInfos Array

Tableau contenant les informations des nœuds dans la zone.

ZoneInfo
InsName String dds-bpxxxxxxxx

ID du nœud.

NodeType String normal

Type du nœud. Valeurs valides :

  • normal
  • configServer
  • shard
  • mongos
Remarque Valeur valide pour les instances Replica Set : normal. Valeurs valides pour les instances Sharded Cluster : configServer, shard et mongos.
RoleId String 83xxxxx

ID du rôle.

RoleType String Primary

Rôle du nœud. Valeurs valides :

  • Primary
  • Secondary
  • Hidden
ZoneId String cn-hangzhou-e

ID de la zone.

Exemples

Exemple de requête

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

Exemples de réponses réussies

Format 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>

Format 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"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.