Retornar todos os clusters autorizados em todos os projetos

OBTER /api/atlas/v1.0/clusters

Retorna os detalhes de todos os clusters em todos os projetos aos quais você tem acesso. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta não inclui clusters multinuvem. Para usar esse recurso, a conta de serviço ou a chave de API solicitante pode ter qualquer função no nível do cluster.

parâmetros de query

envelope booleano

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

O valor padrão é false.
incluir contagem booleano

Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.

O valor padrão é true.
itemsPerPage inteiro

Número de itens que a resposta retorna por página.

O valor mínimo é 1, o valor máximo é 500. O valor padrão é 100.
pageNum inteiro

Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

O valor mínimo é 1. O valor padrão é 1.
pretty booleano

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

O valor padrão é false.

Prettyprint

Respostas

200 aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- links array[objeto]
  
  Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.
  
  Especificação de links da web (RFC...
  
  Ocultar atributos dos links Mostrar atributos dos links objeto
  
  href string
  
  Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
- Resultados array[objeto]
  
  Lista de documentos retornados que o MongoDB Cloud fornece ao concluir esta solicitação.
  
  Ocultar atributos de resultados Mostrar atributos de resultados objeto
  
  clusters array[objeto]
  
  Configurações que descrevem os clusters em cada projeto que a chave de API está autorizada a visualizar.
  
  Configurações que descrevem os clusters em cada projeto que a chave de API está autorizada a visualizar.
  
  Ocultar atributos dos clusters Mostrar atributos dos clusters objeto
  
  alertCount integer(int32)
  
  Número inteiro que indica a quantidade de alertas abertos no cluster.
  
  authEnabled booleano
  
  Sinalizador que indica se a autenticação é necessária para acessar os nós neste cluster.
  
  Disponibilidade string
  
  Termo que expressa quantos nós do cluster podem ser acessados quando a MongoDB Cloud recebe essa solicitação. Este parâmetro retorna available quando todos os nós estão acessíveis, warning somente quando alguns nós no cluster podem ser acessados, unavailable quando o cluster não pode ser acessado ou dead quando o cluster foi desativado.
  
  Os valores são available, dead, unavailable ou warning.
  
  backupEnabled booleano
  
  Sinalizador que indica se o cluster pode executar backups. Se definido como true, o cluster poderá executar backups. Você deve configurar este valor para true para clusters NVMe. O backup usa backups em nuvem para clusters dedicados e backups de cluster compartilhado para clusters de locatário. Se definido como false, o cluster não usará backups do MongoDB Cloud.
  
  clusterId string
  
  Cadeia de caracteres exclusiva 24-hexadecimal que identifica cluster. Cada clusterId é usado apenas uma vez em todos os sistemas do MongoDB Cloud.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  dataSizeBytes integer(int64)
  
  Tamanho total dos dados armazenados em cada nó do cluster. O recurso expressa este valor em bytes.
  
  name string
  
  Etiqueta legível por humanos que identifica o cluster.
  
  O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
  
  nodeCount integer(int32)
  
  Número inteiro que indica a quantidade de nós que compõem o cluster.
  
  sslEnabled booleano
  
  Sinalizador que indica se a autenticação TLS é necessária para acessar os nós neste cluster.
  
  type string
  
  Etiqueta legível por humanos que indica o tipo de cluster.
  
  Os valores são REPLICA_SET ou SHARDED_CLUSTER.
  
  versões array[string]
  
  Lista que contém as versões do MongoDB que cada nó do cluster executa.
  
  groupId string
  
  String exclusiva de 24 caracteres hexadecimais que identifica o projeto.
  
  groupName string
  
  Etiqueta legível por humanos que identifica o projeto.
  
  O formato deve corresponder ao seguinte padrão: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
  
  orgId string
  
  String única de 24caracteres hexadecimais que identifica a organização que contém o projeto.
  
  orgName string
  
  Rótulo legível por humanos que identifica a organização que contém o projeto.
  
  O formato deve corresponder ao seguinte padrão: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
  
  planType string
  
  Etiqueta legível por humanos que indica o tipo de plano.
  
  tags array[string]
  
  Lista de rótulos legíveis por humanos que categorizam o projeto especificado. O MongoDB Cloud retorna uma array vazia.
- contagem total integer(int32)
  
  Número total de documentos disponíveis. O MongoDB Cloud omite este valor se includeCount estiver definido como false. O número total é uma estimativa e pode não ser exato.
  
  O valor mínimo é 0.
401 aplicação/json

Não autorizado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
403 aplicação/json

Forbidden.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
500 aplicação/json

Erro interno do servidor.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.

GET /api/atlas/v1.0/clusters

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/clusters' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Exemplos de resposta (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "clusters": [
        {
          "alertCount": 42,
          "authEnabled": true,
          "availability": "available",
          "backupEnabled": true,
          "clusterId": "string",
          "dataSizeBytes": 42,
          "name": "string",
          "nodeCount": 42,
          "sslEnabled": true,
          "type": "REPLICA_SET",
          "versions": [
            "string"
          ]
        }
      ],
      "groupId": "string",
      "groupName": "string",
      "orgId": "string",
      "orgName": "string",
      "planType": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "totalCount": 42
}

Exemplos de resposta (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Exemplos de resposta (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Exemplos de resposta (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}