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

Nota

Para mais informações, consulte

.

Esta operação aplica-se apenas a instâncias de conjunto de réplicas e cluster com sharding. Instâncias independentes não são compatíveis.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta ferramenta para chamar a operação. O OpenAPI Explorer 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	DescribeRoleZoneInfo	Operação a ser executada. Defina o valor como DescribeRoleZoneInfo.
DBInstanceId	String	Sim	dds-bpxxxxxxxx	ID da instância.
RegionId	String	Não	cn-hangzhou	ID da região da instância. Para obter esse ID, chame a operação DescribeRegions.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	728B9A96-E262-4AE5-915E-3A51CCE2FDA9	ID da solicitação.
ZoneInfos	Array		Array com informações dos nós na zona.
ZoneInfo
InsName	String	dds-bpxxxxxxxx	ID do nó.
NodeType	String	normal	Tipo do nó. Valores válidos: normal configServer shard mongos Nota Valor válido para instâncias de conjunto de réplicas: normal. Valores válidos para instâncias de cluster com sharding: configServer, shard e mongos.
RoleId	String	83xxxxx	ID da função.
RoleType	String	Primary	Função do nó. Valores válidos: Primary Secondary Hidden
ZoneId	String	cn-hangzhou-e	ID da zona.

Exemplos

Exemplo de solicitação

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.