Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Implantações
/
Clusters

Obter um cluster em um projeto

Nesta página

  • Funções obrigatórias
  • Solicitar
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Parâmetros de resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Recupere detalhes de um cluster em um projeto.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer função atribuída.

Solicitar

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

PROJECT-ID

string

Identificador único do projeto.

CLUSTER-ID

string

Identificador único do cluster que você deseja recuperar.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição

status

Código de resposta HTTP

content

Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Parâmetros de resposta

Nome
Tipo
Descrição

clusterName

string

Nome de exibição do cluster. Observe que o mongod em si não permite que você nomeie um cluster; O Cloud Manager fornece este nome e você pode atualizá-lo. Para um conjunto de réplicas em um cluster fragmentado, o nome do cluster é o nome do cluster pai.

groupId

string

Identificador único do projeto ao qual o cluster pertence.

id

string

Identificador único do cluster.

lastHeartbeat

data

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o Cloud Manager processou mais recentemente um ping desse cluster.

replicaSetName

string

Nome do nome do conjunto. O Cloud Manager retorna esse valor quando um cluster tem typeName de REPLICA_SET ou CONFIG_SERVER_REPLICA_SET.

shardName

string

Nome do shard. Cloud Manager retorna esse valor quando um cluster tem typeName de SHARDED ou um REPLICA_SET que faz parte de um cluster fragmentado.

typeName

string

Tipo de cluster. O Cloud Manager pode retornar:

typeName
Descrição

REPLICA_SET

Um conjunto de réplicas.

SHARDED

Um cluster fragmentado em que cada shard é uma instância autônomo . Nenhum fragmento é conjunto de réplicas.

SHARDED_REPLICA_SET

Um cluster fragmentado que contém pelo menos um shard que é um conjunto de réplicas.

CONFIG_SERVER_REPLICA_SET

Servidor de configuração implementados como um conjunto de réplicas.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

1{
2  "clusterName": "myRS",
3  "groupId": "5e84b94c003f2d6370004f4e",
4  "id": "5e8ba20e87d9396ca9b96bd0",
5  "lastHeartbeat": "2020-06-10T14:51:28Z",
6  "links": [
7    {
8      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
9      "rel": "self"
10    }
11  ],
12  "replicaSetName": "myRS",
13  "typeName": "REPLICA_SET"
14}

Voltar

Obter tudo em um projeto

Próximo

UpdateOne