Retorna detalhes sobre todos os containers de emparelhamento de rede no projeto especificado para o fornecedor de nuvem especificado. Se você não especificar o fornecedor de nuvem, o MongoDB Cloud retornará detalhes sobre todos os containers de emparelhamento de rede no projeto para a Amazon Web Services (AWS).
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})$.
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.
Sinalizador que indica se o MongoDB Cloud calcula o número total de itens para a resposta. Ao definir para false, o MongoDB Cloud pode pular uma operação de contagem adicional. A resposta ainda pode incluir totalCount quando a contagem estiver disponível sem cálculo adicional.
O valor padrão é true.
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.
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.
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é false.
Fornecedor de serviços de cloud que atende aos containers de emparelhamento de rede desejados.
Os valores são AWS, AZURE ou GCP. O valor padrão é AWS.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/containers?providerName=AWS' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AZURE",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "string"
}
],
"totalCount": 42
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}