Retornar todos os limites para um projeto

OBTER /api/atlas/v1.0/groups/{groupId}/limits

Retorna todos os limites do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.

parâmetros de caminho

groupId string Obrigatório

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

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.
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
Um dos seguintes:
atlas. projeto.deployment.clusters objeto atlas. projeto.deployment.nodesPerPrivateLinkRegion objeto atlas. projeto.deployment.serverlessMTMs objeto atlas. projeto.security.databaseAccess.customRoles objeto atlas. projeto.security.databaseAccess.users objeto atlas. projeto.security.networkAccess.crossRegionEntries objeto atlas. projeto.security.networkAccess.entries objeto
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.deployment.clusters.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.deployment.nodesPerPrivateLinkRegion.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.deployment.serverlessMTMs.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.security.databaseAccess.customRoles.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.security.databaseAccess.users.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.security.networkAccess.crossRegionEntries.

valor integer(int64) Obrigatório

Valor da definição do limite.
Detalhes dos limites gerenciados pelo usuário.

Ocultar atributos Mostrar atributos

currentUsage integer(int64)

Valor que indica o uso atual do limite.

defaultLimit integer(int64)

Valor padrão do limite.

maximumLimit integer(int64)

Valor máximo do limite.

name string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o limite gerenciado pelo usuário a ser modificado.

O valor é atlas.project.security.networkAccess.entries.

valor integer(int64) Obrigatório

Valor da definição do limite.
400 aplicação/json

Solicitação inválida.
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.
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.
404 aplicação/json

Não encontrado.
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.
409 aplicação/json

Conflito.
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/groups/{groupId}/limits

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

Exemplos de resposta (200)

[
  {
    "currentUsage": 42,
    "defaultLimit": 42,
    "maximumLimit": 42,
    "name": "atlas.project.deployment.clusters",
    "value": 42
  }
]

Exemplos de resposta (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

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 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Exemplos de resposta (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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"
}