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

Descrição da operação

Nota

Para mais informações, consulte Visualizar a zona de um nó.

Esta operação é aplicável a instâncias de conjunto de réplicas e instâncias de cluster fragmentado. Instâncias autônomas não são suportadas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:DescribeRoleZoneInfo

get

*dbinstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bpxxxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	728B9A96-E262-4AE5-915E-3A51CCE2FDA9
ZoneInfos	object
ZoneInfo	array<object>	A lista de informações de distribuição de nós entre as zonas.
	object
InsName	string	O ID do nó.	dds-bpxxxxxxxx
NodeType	string	O tipo de nó. Valores válidos: normal: nó regular configServer: nó de servidor de configuração shard: nó de fragmento mongos: nó mongos Nota Se a instância for uma instância de conjunto de réplicas, o valor retornado será normal. Se a instância for uma instância de cluster fragmentado, os valores retornados incluirão configServer, shard e mongos.	normal
RoleType	string	A função do nó. Valores válidos: Primary: nó primário Secondary: nó secundário Hidden: nó oculto	Primary
ZoneId	string	O ID da zona.	cn-hangzhou-e
RoleId	string	O ID da função.	83xxxxx

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.