Listar Atlas clusters em um projeto

OBTER /api/v1/atlas/projects/{project_id}/clusters
Autenticação do portador

Proxies Atlas Admin API GET /groups/{id}/clusters e GET /groups/{id}/flexClusters usando um token delegado de um chamador humano ou uma conta de serviço do Agent Engine emparelhada. As chaves da API do Agent Engine não são aceitas. Project_id inválido é rejeitado antes de qualquer chamada Atlas .

parâmetros de caminho

  • PROJECT_ID string Obrigatório

    ID do projeto Atlas

Respostas

  • 406

    Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.
  • 200

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Resultados array[objeto]
      Ocultar atributos de resultados Mostrar atributos de resultados objeto
      • connection_string_srv string
      • is_flex booleano
      • name string
      • fornecedor string
      • região string
      • state_name string
      • nível string

        O nível é Flex para clusters Flex e o tamanho de instância do Atlas (M10, M0, ...) de outra forma, incluindo níveis gratuitos/compartilhados. Aparece sem filtro para que os clientes possam manter os níveis gratuitos/compartilhados fora da seleção de cluster e se recusar a adotá-los; a plataforma não bloqueia a seleção do lado do servidor.

    • total_count inteiro
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Resultados array[objeto]
      Ocultar atributos de resultados Mostrar atributos de resultados objeto
      • connection_string_srv string
      • is_flex booleano
      • name string
      • fornecedor string
      • região string
      • state_name string
      • nível string

        O nível é Flex para clusters Flex e o tamanho de instância do Atlas (M10, M0, ...) de outra forma, incluindo níveis gratuitos/compartilhados. Aparece sem filtro para que os clientes possam manter os níveis gratuitos/compartilhados fora da seleção de cluster e se recusar a adotá-los; a plataforma não bloqueia a seleção do lado do servidor.

    • total_count inteiro
  • 400

    INVALID_ID — project_id não é um ID do projeto do Atlas 24-hex

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 401

    PLATFORM_OAUTH_REQUIRED ou PLATFORM_OAUTH_RESOURCE_REJECTED

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 402

    Atlas_payment_METHOD_REQUIRED

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 403

    atlas_permissão_required, atlas_service_account_not_paired ou forBidden

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 404

    NÃO_FOUND

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 409

    Conflito

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 500

    Internal_error

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 502

    Atlas inacessível/resposta não OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 503

    PLATFORM_OAUTH_NOT_CONFIGURED ou SERVIÇO_UNAVAILABLE quando uma atualização de token delegada já estiver em andamento

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
GET /api/v1/atlas/projects/{project_id}/clusters 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/clusters' \
 --header "Authorization: $API_KEY"
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (200) 
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
Exemplos de resposta (200) 
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}