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

Obtém as informações de função e os detalhes de conexão de uma instância MongoDB.

Descrição da operação

Esta operação se aplica a instâncias de conjunto de réplicas e a instâncias de nó único. Não se aplica a instâncias de cluster fragmentado.

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:DescribeReplicaSetRole

get

*Instance

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	Os dados retornados.
RequestId	string	O ID da solicitação.	DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceId	string	O ID da instância.	dds-bpxxxxxxxx
ReplicaSets	object	Os detalhes do conjunto de réplicas.
ReplicaSet	array<object>	Uma lista de nós no conjunto de réplicas.
	object	Os detalhes de um nó.
ConnectionPort	string	The connection port of the node.	3717
ReplicaSetRole	string	The role of the node in the replica set. Primary: primary node. Secondary: secondary node.	Primary
ExpiredTime	string	The remaining time in seconds before the classic network endpoint expires.	1209582
ConnectionDomain	string	The connection endpoint of the node.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkType	string	The network type of the endpoint. VPC: virtual private cloud. Classic: classic network. Public: public network.	VPC
RoleId	string	The role ID of the node.	651xxxxx
ConnectionType	string	The connection type.	SRV
ConnectionStringSuffix	string	O sufixo de nome de domínio para a string de conexão.	.mongodb.rds.aliyuncs.com

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx",
        "ConnectionType": "SRV"
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com\n"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden	User not authorized to operate on the specified resource.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.