API de administração do MongoDB Atlas (1.0)

Baixar especificação OpenAPI:Baixar

Licença: CC BY-NC-SA 3.0 US termos de serviço

A API de Administração do MongoDB Atlas permite aos desenvolvedores gerenciar todos os componentes no MongoDB Atlas.

A API de Administração do Atlas usa a autenticação Digest HTTP para autenticar solicitações. Forneça uma chave pública de API programática e a chave privada correspondente como nome de usuário e senha ao criar a solicitação HTTP. Por exemplo, para retornar o histórico de acesso ao banco de dados com cURL, execute o seguinte comando no terminal:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest \
  --header "Accept: application/json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"

Para saber mais, consulte Introdução à API Atlas Administration. Para obter suporte, consulte Suporte ao MongoDB.

Rastreamento de acesso

Retorna os registros de acesso para tentativas de autenticação feitas nos sistemas do banco de dados Atlas. Para visualizar o histórico de acesso ao banco de dados, você deve ter a função Project Owner (Proprietário do projeto) ou Organization Owner (Proprietário da organização).

Retornar histórico de acesso ao banco de dados para um cluster usando seu nome de cluster

Retorna os registros de acesso de um cluster identificado pelo nome do cluster. Os registros de acesso contêm uma lista de solicitações de autenticação feitas em seu cluster. Você não pode utilizar esta funcionalidade em clusters de nível de locatário (M0, M2, M5). Para usar esse recurso, a chave de API solicitante deve ter a função de administrador do Project Monitoring.

Histórico de acesso ao banco de dados

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
authResult	booleano Sinalizador que indica se a resposta retorna apenas as tentativas de autenticação bem-sucedidas.
end	inteiro <int64> Data e hora para parar de recuperar o histórico do banco de dados. Se você especificar o fim, você também deverá especificar o início. Este parâmetro usa o tempo UNIX epoch em milissegundos.
ipAddress	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Um endereço de protocolo de internet que tentou autenticar com o banco de dados.
nLogs	inteiro <int32> [ 0 .. 20000 ] Padrão: 20000 Número máximo de linhas do registro a serem retornadas.
iniciar	inteiro <int64> Data e hora em que o MongoDB Cloud começa a recuperar o histórico do banco de dados. Se você especificar o início, também deverá especificar o fim. Este parâmetro usa o tempo UNIX epoch em milissegundos.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"accessLogs": [{"authResult": true,
"authSource": "string",
"failureReason": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostname": "string",
"ipAddress": "string",
"logLine": "string",
"timestamp": "string",
"username": "string"
}
]
}

Retornar o histórico de acesso ao banco de dados para um cluster usando seu nome de host

Retorna os registros de acesso de um cluster identificado pelo nome de host do cluster. Os registros de acesso contêm uma lista de solicitações de autenticação feitas em seus clusters. Você não pode utilizar esta funcionalidade em clusters de nível de locatário (M0, M2, M5). Para usar esse recurso, a chave de API solicitante deve ter a função de administrador do Project Monitoring.

Histórico de acesso ao banco de dados

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

nome do host

necessário

string

Nome de domínio totalmente qualificado ou endereço IP do host do MongoDB que armazena os arquivos de registro que você deseja baixar.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
authResult	booleano Sinalizador que indica se a resposta retorna apenas as tentativas de autenticação bem-sucedidas.
end	inteiro <int64> Data e hora para parar de recuperar o histórico do banco de dados. Se você especificar o fim, você também deverá especificar o início. Este parâmetro usa o tempo UNIX epoch em milissegundos.
ipAddress	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Um endereço de protocolo de internet que tentou autenticar com o banco de dados.
nLogs	inteiro <int32> [ 0 .. 20000 ] Padrão: 20000 Número máximo de linhas do registro a serem retornadas.
iniciar	inteiro <int64> Data e hora em que o MongoDB Cloud começa a recuperar o histórico do banco de dados. Se você especificar o início, também deverá especificar o fim. Este parâmetro usa o tempo UNIX epoch em milissegundos.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"accessLogs": [{"authResult": true,
"authSource": "string",
"failureReason": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostname": "string",
"ipAddress": "string",
"logLine": "string",
"timestamp": "string",
"username": "string"
}
]
}

Configurações de alerta

Retorna e edita as condições que acionam os alertas e como o MongoDB Cloud notifica os usuários. Esta collection permanece sob revisão e pode mudar.

Obtenha todos os nomes de campo dos correspondentes de configuração de alertas

Obtenha todos os nomes de campo que o parâmetro matchers.fieldName aceita ao criar ou atualizar uma Configuração de Alerta. Você pode chamar esse endpoint com sucesso com qualquer função atribuída.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

["APPLICATION_ID"
]

Retornar todas as configurações de alerta para um projeto

Retorna todas as configurações de alerta para um projeto. Essas configurações de alerta são válidas para qualquer componente do projeto. As configurações de alerta definem os acionadores e os métodos de notificação para alertas. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Criar uma configuração de alerta em um projeto

Criar uma configuração de alerta para o projeto especificado. As configurações de alerta definem os acionadores e os métodos de notificação para alertas. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria uma configuração de alerta para o projeto especificado.

Um dos

habilitado	booleano Padrão: false Sinalizador que indica se alguém habilitou esta configuração de alerta para o projeto especificado.
necessário	Tipos de evento de faturamento (objeto) ou Tipos de evento de backup de Cps (objeto) ou Tipos de auditoria de índice FTS (objeto) ou Tipos de evento de grupo (objeto) ou Tipos de auditoria de NDS (objeto) ou Tipos de auditoria de janela de manutenção de NDS (objeto) ou Tipos de evento de arquivo online (objeto) ou Tipos de evento de usuário (objeto) ou Tipos de evento de recurso (objeto) ou Tipos de evento de processador de fluxo (objeto) ou Tipos de auditoria de dimensionamento automático de NDS (objeto) Incidente que acionou este alerta.
	Array de objetos (Correspondentes) Condições correspondentes para recursos de destino.
necessário	Array de Notificação Datadog (objeto) ou Notificação por e-mail (objeto) ou Notificação de grupo (objeto) ou Notificação HipChat (objeto) ou Notificação do Microsoft Teams (objeto) ou Notificação OpsGenie (objeto) ou Notificação de organização (objeto) ou Notificação PagerDuty (objeto) ou Notificação do Slack (objeto) ou Notificação por SMS (objeto) ou Notificação de equipe (objeto) ou Notificação de usuário (objeto) ou Notificação VictorOps (objeto) ou Notificação Webhook (objeto) (AlertsNotificationRootForGroup) Lista que contém os destinos para o quais o MongoDB Cloud envia notificações.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
]
}

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

Remover uma configuração de alerta de um projeto

Remove uma configuração de alerta do projeto especificado. Para usar esse recurso, a chave de API solicitada deve ter a role Proprietário da organização ou Proprietário do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertConfigId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica a configuração do alerta. Use o endpoint /alertConfigs para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

401
404
500

Tipo de conteúdo

aplicação/json

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

Retornar uma configuração de alerta de um projeto

Retorna a configuração de alerta especificada do projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertConfigId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica a configuração do alerta. Use o endpoint /alertConfigs para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

Alternar um estado de uma configuração de alerta em um projeto

Habilita ou desabilita a configuração de alerta especificada no projeto indicado. O recurso habilita a configuração de alerta especificada se estiver habilitada no momento. O recurso desativa a configuração de alerta especificada se estiver desativada no momento. Para usar esse recurso, a chave de API solicitada deve ter a função Proprietário da organização ou Proprietário do projeto.

NOTA: esse endpoint atualiza apenas o estado ativado/desativado da configuração de alerta. Para atualizar mais do que apenas essa configuração, consulte Atualizar uma configuração de alerta.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertConfigId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica a configuração de alerta que acionou esse alerta. Use o endpoint /alertConfigs para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Habilita ou desabilita a configuração de alerta especificada no projeto indicado.

habilitado

booleano

Sinalizador que indica se a configuração de alerta especificada deve ser habilitada ou desabilitada no projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

Atualizar uma configuração de alerta para um projeto

Atualiza uma configuração de alerta no projeto especificado. As configurações de alerta definem os acionadores e os métodos de notificação para alertas. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

OBSERVAÇÃO: para habilitar ou desabilitar a configuração de alerta, consulte Alternar um estado de uma configuração de alerta em um projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertConfigId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica a configuração do alerta. Use o endpoint /alertConfigs para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza uma configuração de alerta no projeto especificado.

Um dos

habilitado	booleano Padrão: false Sinalizador que indica se alguém habilitou esta configuração de alerta para o projeto especificado.
necessário	Tipos de evento de faturamento (objeto) ou Tipos de evento de backup de Cps (objeto) ou Tipos de auditoria de índice FTS (objeto) ou Tipos de evento de grupo (objeto) ou Tipos de auditoria de NDS (objeto) ou Tipos de auditoria de janela de manutenção de NDS (objeto) ou Tipos de evento de arquivo online (objeto) ou Tipos de evento de usuário (objeto) ou Tipos de evento de recurso (objeto) ou Tipos de evento de processador de fluxo (objeto) ou Tipos de auditoria de dimensionamento automático de NDS (objeto) Incidente que acionou este alerta.
	Array de objetos (Correspondentes) Condições correspondentes para recursos de destino.
necessário	Array de Notificação Datadog (objeto) ou Notificação por e-mail (objeto) ou Notificação de grupo (objeto) ou Notificação HipChat (objeto) ou Notificação do Microsoft Teams (objeto) ou Notificação OpsGenie (objeto) ou Notificação de organização (objeto) ou Notificação PagerDuty (objeto) ou Notificação do Slack (objeto) ou Notificação por SMS (objeto) ou Notificação de equipe (objeto) ou Notificação de usuário (objeto) ou Notificação VictorOps (objeto) ou Notificação Webhook (objeto) (AlertsNotificationRootForGroup) Lista que contém os destinos para o quais o MongoDB Cloud envia notificações.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outra configuração de alerta

{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

Retornar todas as configurações de alerta definidas para um alerta

Retorna todas as configurações de alerta definidas para o alerta especificado. Para usar este recurso, a chave da API solicitante deve ter a função de Somente Leitura do Projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

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

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Alertas

Retorna e reconhece os alertas que o MongoDB Cloud aciona com base nas condições de alerta definidas por você. Esta collection permanece sob revisão e pode mudar.

Retornar todos os alertas abertos para configuração de alerta

Retorna todos os alertas abertos que a configuração de alerta especificada aciona. Estas configurações de alerta se aplicam somente ao projeto especificado. As configurações de alerta definem os triggers e os métodos de notificação para alertas. Alertas abertos foram acionados, mas permanecem não reconhecidos. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertConfigId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica a configuração do alerta. Use o endpoint /alertConfigs para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
"acknowledgingUsername": "user@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Retornar todos os alertas de um projeto

Retorna todos os alertas. Esses alertas são válidos para todos os componentes de um projeto. Você receberá um alerta quando um componente monitorado atingir ou ultrapassar um valor que você definiu. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
Status	string Enum: "ABRIR" "RASTREAMENTO" "Fechado" Status dos alertas a serem retornados. Omitir para retornar todos os alertas em todos os status.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
"acknowledgingUsername": "user@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Retornar um alerta de um projeto

Retorna um alerta. Este alerta se aplica a qualquer componente em um projeto. Você recebe um alerta quando um componente monitorado atinge ou excede um valor definido por você. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

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

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Alertas do App Services

{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
"acknowledgingUsername": "user@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}

Reconhecer um alerta de um projeto

Confirma o recebimento de um alerta existente. Esse alerta é válido para qualquer componente de um projeto. Confirmar o recebimento de um alerta evita notificações sucessivas. Você recebe um alerta quando um componente monitorado atinge ou excede um valor definido até que você confirme o alerta. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

alertId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

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

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Confirma ou não um alerta.

acknowledgedUntil

string <date-time>

Data e hora até a qual este alerta foi reconhecido. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. O recurso retorna este parâmetro se um usuário do MongoDB reconheceu este alerta anteriormente.

Para reconhecer este alerta para sempre, defina o valor do parâmetro para 100 anos no futuro.
Para cancelar a confirmação de um alerta confirmado anteriormente, não defina o valor desse parâmetro.

acknowledgementComment

string <= 200 caracteres

Comentário que um usuário do MongoDB Cloud enviou ao reconhecer o alerta.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days."
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Alertas do App Services

{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
"acknowledgingUsername": "user@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}

Atlas Search

Retorna, adiciona, edita e remove índices do Atlas Search para o cluster especificado. Também retorna e atualiza analisadores definidos pelo usuário para o cluster especificado.

Retornar todos os analisadores definidos pelo usuário para um cluster

Retorna todos os analisador personalizado do Atlas Search que o cluster especificado utiliza no projeto especificado. Os analisadores personalizados definem as operações a serem executadas para indexar um campo. Para usar este recurso, a API solicitada deve ter o role de Leitura e Gravação do projeto de Acesso a Dados.

Analisadores personalizados

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Nome do cluster que contém a coleção com um ou mais índices do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

[{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
]

Atualizar todos os analisadores definidos pelo usuário para um cluster

Atualiza um ou mais analisador personalizado do Atlas Search no cluster especificado. Os analisadores personalizados definem as operações a serem executadas para indexar um campo. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso a dados do projeto".

Analisadores personalizados

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Nome do cluster que contém a coleção com um ou mais índices do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza um ou mais analisador personalizado do Atlas Search no cluster especificado.

Array

	Array de htmlStrip (objeto) ou icuNormalize (objeto) ou mapeamento (objeto) ou persian (objeto) Filtros que examinam o texto de um caractere de cada vez e executam operações de filtragem.
name necessário	string Nome legível por humanos que identifica o analisador personalizado. Os nomes devem ser únicos dentro de um índice e não devem começar com nenhuma das seguintes strings: `lucene.` `builtin.` `mongodb.`
	Array de asciiFolding (objeto) ou daitchMokotoffSoundex (objeto) ou edgeGram (objeto) ou englishPossessive (objeto) ou flattenGraph (objeto) ou icuFolding (objeto) ou icuNormalizer (objeto) ou kStemming (objeto) ou comprimento (objeto) ou minúsculas (objeto) ou ou wordDelimiterGraph (objeto) Filtro que executa operações como: Stemming, que reduz palavras relacionadas, como "falar", "falou" e "fala" à sua palavra raiz "falar". Redação, remoção de informações confidenciais de documentos públicos.
necessário	objeto Tokenizador que você deseja utilizar para criar tokens. Os tokens determinam como o Atlas Search faz a divisão do texto em partes para indexação.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
]

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

[{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
]

Criar um índice do Atlas Search

Cria um índice do Atlas Search na collection especificada. Os índices do Atlas Search definem os campos nos quais criar o índice e os analyzers a serem usados ao criar o índice. Somente clusters executando o MongoDB v4.2 ou posterior podem usar o Atlas Search. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.

Índices de pesquisa do Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Nome do cluster que contém a coleção na qual criar um índice do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria um índice do Atlas Search na collection especificada.

collectionName necessário	string Rótulo legível por humanos que identifica a coleção que contém um ou mais índices do Atlas Search.
database necessário	string Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search.
name necessário	string Rótulo legível por humanos que identifica este índice. Dentro de cada namespace, os nomes de todos os índices do namespace devem ser únicos.
type	string Tipo de índice. O tipo padrão é pesquisar. Pesquisar
analisador	string Padrão: "lucene.standard" Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" Método pré-definido específico escolhido para converter texto do campo do banco de dados em palavras pesquisáveis. Essa conversão reduz o texto dos campos nas menores unidades de texto. Essas unidades são chamadas de termo ou token. Esse processo, conhecido como tokenização, envolve uma variedade de alterações feitas no texto nos campos: extraindo palavras remover pontuação removendo acentos mudando para minúsculas removendo palavras comuns reduzindo palavras à sua forma raiz (stemming) alterar as palavras para sua forma básica (lematização). O MongoDB Cloud usa o processo selecionado para criar o índice do Atlas Search. Analisadores de Atlas Search
	Array de objetos (analisadores) Lista de métodos definidos pelo usuário para converter texto do campo do banco de dados em palavras pesquisáveis. Analisadores personalizados do Atlas Search
	objeto (mapeamentos) Especificações de índice para os campos da collection.
searchAnalyzer	string Padrão: "lucene.standard" Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" Método aplicado para identificar palavras ao pesquisar este índice.
fonte armazenada	objeto Sinalizador que indica se deve armazenar todos os campos (verdadeiro) no Atlas Search. Por padrão, o Atlas não armazena (falso) os campos no Atlas Search. Como alternativa, você pode especificar um objeto que contém somente a lista de campos para armazenar (incluir) ou não armazenar (excluir) no Atlas Search. Para saber mais, consulte a documentação. Campos de Origem Armazenados
	Array de objetos (Definição de mapeamento sinônimo) Conjuntos de regras que mapeiam palavras em relação a seus sinônimos neste índice. Mapeamento de sinônimos

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

Pesquisar

{"collectionName": "string",
"database": "string",
"name": "string",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

Exemplos de resposta

200
400
404
409
500

Tipo de conteúdo

aplicação/json

Exemplo

Pesquisar

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

Retornar todas as índices do Atlas Search para uma collection

Retorna todos os índices do Atlas Search na collection especificada. Os índices do Atlas Search contêm os campos indexados e os analisadores utilizados para criar os índices. Para usar este recurso, a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.

Índices de pesquisa do Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Nome do cluster que contém a coleção com um ou mais índices do Atlas Search.
collectionName necessário	string Nome da coleção que contém um ou mais índices do Atlas Search.
Nome do Banco de Dados necessário	string Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

[{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"status": "IN_PROGRESS",
"type": "search"
}
]

Remover um índice do Atlas Search

Remove um índice de Atlas Search que você identificou com ID único. Para usar este recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.

Índices de pesquisa do Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Nome do cluster que contém o banco de dados e a coleção com um ou mais índices de pesquisa de aplicativo.
indexId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Sequência única de 24 dígitos hexadecimais que identifica o índice do Atlas Search. Use o endpoint da API Get All Atlas Search Indexes for a Collection para encontrar as IDs de todos os índices do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um índice do Atlas Search

Retorna um índice do Atlas Search no projeto especificado. Use seu ID único para identificar este índice. O índice do Atlas Search contém os campos indexados e os analisadores utilizados para criar o índice. Para usar este recurso, a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.

Índices de pesquisa do Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Nome do cluster que contém a coleção com um ou mais índices do Atlas Search.
indexId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o índice do Application Search. Use o endpoint da API Get All Application Search Indexes for a Collection para encontrar as IDs de todos os índices do Atlas Application.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Pesquisar

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

Atualizar um Atlas Search Index

Atualiza um índice do Atlas Search que você identificou com seu ID exclusivo. Os índices do Atlas Search definem os campos nos quais criar o índice e os analyzers a serem usados ao criar o índice. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.

Índices de pesquisa do Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Nome do cluster que contém a collection cujo índice do Atlas Search atualizar.
indexId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o índice do Atlas Search. Use o endpoint Get All Atlas Search Indexes for a Collection API (Obter todos os índices do Atlas Search para uma API da coleção) para encontrar os ID de todos os índices do Atlas Search.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes a serem atualizados no índice do Atlas Search.

collectionName necessário	string Rótulo legível por humanos que identifica a coleção que contém um ou mais índices do Atlas Search.
database necessário	string Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search.
name necessário	string Rótulo legível por humanos que identifica este índice. Dentro de cada namespace, os nomes de todos os índices do namespace devem ser únicos.
type	string Tipo de índice. O tipo padrão é pesquisar. Pesquisar
analisador	string Padrão: "lucene.standard" Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" Método pré-definido específico escolhido para converter texto do campo do banco de dados em palavras pesquisáveis. Essa conversão reduz o texto dos campos nas menores unidades de texto. Essas unidades são chamadas de termo ou token. Esse processo, conhecido como tokenização, envolve uma variedade de alterações feitas no texto nos campos: extraindo palavras remover pontuação removendo acentos mudando para minúsculas removendo palavras comuns reduzindo palavras à sua forma raiz (stemming) alterar as palavras para sua forma básica (lematização). O MongoDB Cloud usa o processo selecionado para criar o índice do Atlas Search. Analisadores de Atlas Search
	Array de objetos (analisadores) Lista de métodos definidos pelo usuário para converter texto do campo do banco de dados em palavras pesquisáveis. Analisadores personalizados do Atlas Search
	objeto (mapeamentos) Especificações de índice para os campos da collection.
searchAnalyzer	string Padrão: "lucene.standard" Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" Método aplicado para identificar palavras ao pesquisar este índice.
fonte armazenada	objeto Sinalizador que indica se deve armazenar todos os campos (verdadeiro) no Atlas Search. Por padrão, o Atlas não armazena (falso) os campos no Atlas Search. Como alternativa, você pode especificar um objeto que contém somente a lista de campos para armazenar (incluir) ou não armazenar (excluir) no Atlas Search. Para saber mais, consulte a documentação. Campos de Origem Armazenados
	Array de objetos (Definição de mapeamento sinônimo) Conjuntos de regras que mapeiam palavras em relação a seus sinônimos neste índice. Mapeamento de sinônimos

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

Pesquisar

{"collectionName": "string",
"database": "string",
"name": "string",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

Exemplos de resposta

200
400
404
409
500

Tipo de conteúdo

aplicação/json

Exemplo

Pesquisar

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

Auditoria

Retorna e edita configurações de auditoria do banco de dados para projetos da nuvem do MongoDB.

Retornar a configuração de auditoria para um projeto

Retorna a configuração de auditoria do projeto especificado. A configuração de auditoria define os eventos que o MongoDB Cloud registra no registro de auditoria. Para utilizar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto. Este recurso não está disponível para M0, M2, M5 ou clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"auditAuthorizationSuccess": false,
"auditFilter": "string",
"configurationType": "NONE",
"enabled": false
}

Atualizar a configuração de auditoria para um projeto

Atualiza a configuração de auditoria do projeto especificado. A configuração de auditoria define os eventos que o MongoDB Cloud registra no log de auditoria. Para usar esse recurso, a chave de API solicitada deve ter a role de Proprietário do projeto. Este recurso não está disponível para M0, M2, M5 ou clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Configuração de auditoria atualizada do projeto especificado.

auditAuthorizationSuccess	booleano Padrão: false Sinalizador que indica se alguém definiu a auditoria para acompanhar as autenticações bem-sucedidas. Isto aplica-se apenas ao filtro de auditoria `"atype" : "authCheck"`. Definir esse parâmetro como `true` enfraquece o desempenho do cluster. Mensagens de auditoria do sistema
auditFilter	string Documento JSON que especifica quais eventos dever ser gravados. Use uma barra invertida (`\`) para evitar caracteres que possam impedir a análise, como aspas simples ou duplas. Filtro de auditoria personalizado
habilitado	booleano Padrão: false Sinalizador que indica se alguém habilitou a auditoria do banco de dados para o projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"auditAuthorizationSuccess": false,
"auditFilter": "string",
"enabled": false
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"auditAuthorizationSuccess": false,
"auditFilter": "string",
"configurationType": "NONE",
"enabled": false
}

DNS de clusters AWS

Retorna e edita configurações de DNS personalizadas para implantações de banco de dados do MongoDB na nuvem na AWS. O recurso exige seu ID do projeto. Se você usa o emparelhamento VPC na AWS e seus próprios servidores DNS em vez do Amazon Route 53, habilite o DNS personalizado. Antes de 31 de março de 2020, os aplicativos implementados na AWS usando serviços DNS personalizados e com VPC emparelhado com MongoDB Cloud não podiam se conectar por meio de endereços IP privados. DNS personalizado resolvido para endereços IP públicos. DNS interno AWS resolvido para endereços IP privados. Os aplicativos implantados com serviços DNS personalizados na AWS devem usar um IP privado para o emparelhamento de cadeias de conexão.

Retornar uma configuração de DNS personalizada para Atlas clusters na AWS

Retorna a configuração de DNS personalizada para clusters AWS no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Alternar estado de uma configuração de DNS personalizada para Atlas clusters na AWS

Habilita ou desabilita a configuração de DNS personalizada para clusters AWS no projeto especificado. Habilite o DNS personalizado se você utiliza o emparelhamento de AWS VPC e usa seus próprios servidores DNS. Para utilizar esse recurso, a chave API solicitante deve ter a função de "Administrador Atlas do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Habilita ou desabilita a configuração de DNS personalizada para clusters AWS no projeto especificado.

habilitado

necessário

booleano

Sinalizador que indica se os clusters do projeto distribuídos no Amazon Web Services (AWS) usam um sistema de nomes de domínio (DNS) personalizado. Quando "enabled": true, conecte-se ao seu cluster usando o IP privado para o emparelhamento de cadeias de conexão.

Para saber mais, consulte as Perguntas frequentes: opções de cadeias de conexão na documentação do MongoDB Atlas.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

backups em nuvem

Gerencia snapshots de backups em nuvem, buckets de exportação de snapshots, tarefas de restauração e agendamentos. Este recurso se aplica apenas a clusters que usam backups em nuvem.

Retornar todos os buckets de exportação de snapshot

Retorna todos os buckets de exportação associados ao projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Criar um bucket de exportação de snapshot

Cria um bucket de exportação para um determinado Amazon Web Services 3 bucket do Amazon Web Services S. Depois de criados, os snapshots podem ser exportados para o Bucket de Exportação e seu Amazon Web Services 3 bucket S do Amazon Web Services referenciado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Especifica o Amazon Web Services 3 bucket do Amazon Web Services S e o role IAM ao qual o bucket de exportação deve fazer referência.

bucketName necessário	string [ 3 ... 63 ] caracteres Etiqueta legível por humanos que identifica o bucket AWS S3 ou o contêiner de armazenamento do Azure para o qual a função está autorizada a exportar.
cloudProvider necessário	string Enum: "AWS" "AZURE" Etiqueta legível por humanos que identifica o provedor de nuvem para o qual os snapshots são exportados.
iamRoleId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 3 hexadecimal que identifica o ID de role do AWS Access unificado que o MongoDB Cloud usa para acessar o bucket AWS S3.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Excluir um bucket de exportação de snapshot

Exclui um bucket de exportação. A exportação automática deve ser desabilitada em todos os clusters desse projeto que são exportados para esse bucket de exportação antes de revogar o acesso. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

exportBucketId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um bucket de exportação de snapshot

Retorna um bucket de exportação associado ao projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

exportBucketId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Retornar as configurações da Política de compliance de backup

Retorna as configurações da Política de conformidade de backup com o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
],
"state": "ACTIVE",
"updatedDate": "2019-08-24T14:15:22Z",
"updatedUser": "user@example.com"
}

Atualize ou habilite as configurações da Política de Compliance de Backup

Atualiza as configurações da Política de Conformidade de Backup para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
overwriteBackupPolicies	booleano Padrão: true Sinalização que indica se as políticas de backup não conformes devem ser substituídas pelas novas configurações de proteção de dados.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Esquema do corpo da solicitação: application/json

As novas configurações da Política de compliance de backup.

authorizedEmail necessário	string <email> Endereço de e-mail do usuário que autorizou a atualização das configurações da Política de compliance de backup.
authorizedUserFirstName	string Nome do usuário que autorizou a atualização das configurações da Política de compliance de backup.
authorizedUserLastName	string Sobrenome do usuário que autorizou a atualização das configurações da Política de Conformidade de Backup.
copyProtectionEnabled	booleano Padrão: false Sinalizador que indica se deve impedir que usuários de clusters excluam backups copiados para outras regiões, mesmo que essas regiões de snapshot adicionais sejam removidas. Se não for especificado, esse valor assumirá falso como padrão.
encryptionAtRestEnabled	booleano Padrão: false Sinalizador que indica se a Encryption at rest usando o Gerenciamento de chaves do consumidor é necessária para todos os clusters com uma Política de compliance de backup. Se não for especificado, esse valor assumirá falso como padrão. Criptografia em repouso usando o gerenciamento de chaves de cliente
	objeto (BackupComplianceOnDemandPolicyItem) Especificações para a política on-demand.
pitEnabled	booleano Padrão: false Sinalizador que indica se o cluster usa backups contínuos em nuvem com uma Política de compliance de backup. Se não for especificado, esse valor assumirá falso como padrão. Backups contínuos da nuvem
projectId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o projeto para a Política de Conformidade de Backup.
restoreWindowDays	inteiro <int32> Número de dias anteriores para os quais você pode restaurar com o backup contínuo na nuvem com uma política de compliance de backup. Você deve especificar um número inteiro positivo, diferente de zero, e a janela de retenção máxima não pode exceder o tempo de retenção por hora. Esse parâmetro se aplica somente aos backups contínuos na nuvem com uma política de compliance de backup.
	Array de objetos (BackupComplianceScheduledPolicyItem) Lista que contém as especificações de uma política agendada.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 0
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
],
"state": "ACTIVE",
"updatedDate": "2019-08-24T14:15:22Z",
"updatedUser": "user@example.com"
}

Retornar todas as tarefas de exportação de snapshot

Retorna todas as tarefas de exportação de snapshots de backup em nuvem associados ao cluster Atlas especificado. Para utilizar esse recurso, a chave API solicitante deve ter a função de Administrador Atlas do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled"
}
],
"totalCount": 0
}

Criar um trabalho de exportação de snapshot

Exporta um snapshot de backup para um cluster do Atlas dedicado usando backups em nuvem para um bucket de exportação. Para utilizar esse recurso, a chave API solicitante deve ter a função de Administrador Atlas do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Informações sobre a tarefa de exportação de snapshot de backup em nuvem a ser criado.

	Array de objetos (BackupLabel) Collection de pares de chave-valor que representam dados personalizados a serem adicionados ao arquivo de metadados que o MongoDB Cloud carrega no bucket quando o trabalho de exportação é concluído.
exportBucketId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24caracteres hexadecimais que identifica o snapshot do backup em nuvem a ser exportado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled"
}

Retornar um trabalho de exportação de snapshot

Retorna uma tarefa de exportação de snapshot de backup em nuvem associado ao cluster Atlas especificado. Para utilizar esse recurso, a chave API solicitante deve ter a função de Administrador Atlas do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
exportId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 24exclusivo -string de caracteres hexadecimais que identifica a tarefa de exportação.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled"
}

Retornar todos os trabalhos de restauração para um cluster

Retorna todas as tarefas de restauração de backup em nuvem para um cluster de um projeto especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster com as tarefas de restauração que você deseja retornar.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cancelled": true,
"components": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Restaurar um snapshot de um cluster

Restaura um snapshot de um cluster do projeto especificado. O Atlas faz snapshots sob demanda imediatamente e snapshots agendados periodicamente. Se houver um snapshot sob demanda com status queued ou inProgress, antes de fazer outro snapshot, aguarde até que o Atlas conclua o processamento do snapshot sob demanda tirado anteriormente.

Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Restaura um snapshot de um cluster do projeto especificado.

deliveryType necessário	string Enum: "automated" "download" "pointInTime" Rótulo legível por humanos que categoriza a tarefa de restauração a ser criada.
oplogInc	inteiro <int32> >= 1 Número de operação Oplog da qual você deseja restaurar esse snapshot. Esse número representa a segunda parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando `"deliveryType" : "pointInTime"` e oplogTs ultrapassam `0`.
oplogTs	inteiro <int32> >= 1199145600 Data e hora a partir das quais você deseja restaurar esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. Esse número representa a primeira parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando `"deliveryType" : "pointInTime"` e oplogTs ultrapassam `0`.
pointInTimeUTCSeconds	inteiro <int32> >= 1199145600 Data e hora em que a nuvem do MongoDB Cloud restaurou esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. O recurso retorna este parâmetro quando `"deliveryType" : "pointInTime"` e pointInTimeUTCSeconds ultrapassam `0`.
snapshotId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.
targetClusterName	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica o cluster de destino no qual a tarefa de restauração restaura o snapshot. O recurso retorna esse parâmetro quando `"deliveryType":` `"automated"`. Necessário para tipos de restauração do `automated` e `pointInTime`.
targetGroupId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado. Necessário para tipos de restauração do `automated` e `pointInTime`.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"deliveryType": "automated",
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"cancelled": true,
"components": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

Cancelar uma tarefa de restauração de um cluster

Cancela uma tarefa de restauração de backup em nuvem de um cluster de um projeto especificado. Para usar esse recurso, a chave de API solicitada deve ter a role de Proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
restoreJobId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Sequência única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser removida.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
405
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma tarefa de restauração de um cluster

Retorna uma tarefa de restauração de backup em nuvem para um cluster de um projeto especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica o cluster com as tarefas de restauração que você deseja retornar.
restoreJobId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser retornada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"cancelled": true,
"components": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

Remover todos os agendamentos de backup em nuvem

Remove todos os agendamentos de backup em nuvem do cluster especificado. Esse agendamento define quando a nuvem do MongoDB realiza snapshots agendados e por quanto tempo armazena esses snapshots. Para utilizar esse recurso, a chave API solicitante deve ter a função de "Administrador Atlas do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"replicationSpecId": "string",
"shouldCopyOplogs": true
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "stringstringstringstring",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

Retornar um agendamento de backup em nuvem

Retorna o cronograma de backup em nuvem para o cluster especificado dentro do projeto especificado. Esse agendamento define quando o MongoDB Cloud realiza snapshots programados e por quanto tempo os armazena. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"replicationSpecId": "string",
"shouldCopyOplogs": true
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "stringstringstringstring",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

Atualizar o agendamento de backup em nuvem para um cluster

Atualiza o agendamento de backup em nuvem para um cluster dentro do projeto especificado. Esse agendamento define quando o MongoDB Cloud realiza snapshots programados e por quanto tempo os armazena. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza o agendamento de backup em nuvem para um cluster dentro do projeto especificado.

Observação: no corpo da solicitação, forneça apenas os campos que você deseja atualizar.

autoExportEnabled	booleano Sinalizador que indica se o MongoDB Cloud exporta automaticamente os Snapshots de Backup em Nuvem para o Bucket de Exportação.
	Array de objetos (DiskBackupCopySetting) Lista que contém um documento para cada item de configuração de cópia na política de backup desejada.
	Array de objetos (DeleteCopiedBackups) Lista que contém um documento para cada configuração de cópia excluída cujas cópias de backup você deseja excluir.
	objeto (export) Política para exportar automaticamente snapshots de backup em nuvem.
	Array de objetos (ExtraRetentionSetting) Lista que contém um documento para cada item de configuração de retenção extra na política de backup desejada.
	Array de objetos (AdvancedDiskBackupSnapshotSchedulePolicy) <= 1 itens Regras definidas para este agendamento de backup.
referenceHourOfDay	inteiro <int32> Hora do dia no Horário Universal Coordenado (UTC) que representa quando o MongoDB Cloud faz o snapshot.
referenceMinuteOfHour	inteiro <int32> Minuto do referenceHourOfDay que representa quando a nuvem do MongoDB tira o snapshot.
restoreWindowDays	inteiro <int32> Número de dias anteriores para os quais você pode restaurar com precisão do Continuous Cloud Backup. Você deve especificar um número inteiro positivo, diferente de zero. Esse parâmetro se aplica somente aos backups contínuos na nuvem.
updateSnapshots	booleano Sinalizador que indica se as alterações de retenção na política de backup atualizada devem ser aplicadas aos snapshots que o MongoDB Cloud fez anteriormente.
useOrgAndGroupNamesInExportPrefix	booleano Sinalizador que indica quando usar os nomes da organização e do projeto em vez dos UUIDs da organização e do projeto no caminho para os arquivos de metadados que o MongoDB Cloud faz upload para o seu Export Bucket.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"autoExportEnabled": true,
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"replicationSpecId": "string",
"shouldCopyOplogs": true
}
],
"deleteCopiedBackups": [{"cloudProvider": "AWS",
"regionName": "string",
"replicationSpecId": "string",
"zoneId": "string"
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"policies": [{"id": "stringstringstringstring",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"updateSnapshots": true,
"useOrgAndGroupNamesInExportPrefix": true
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"replicationSpecId": "string",
"shouldCopyOplogs": true
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "stringstringstringstring",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

Retornar todos os backups em nuvem do conjunto de réplicas

Retorna todos os snapshots de um cluster do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}
],
"totalCount": 0
}

Fazer um snapshot on-demand

Faz um snapshot sob demanda para o cluster especificado. O Atlas faz snapshots sob demanda imediatamente e snapshots agendados periodicamente. Se houver um snapshot sob demanda com status queued ou inProgress, antes de fazer outro snapshot, aguarde até que o Atlas conclua o processamento do snapshot sob demanda tirado anteriormente.

Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Tira um snapshot sob demanda.

Descrição	string Frase legível para humanos que explica a finalidade do snapshot. O recurso retorna este parâmetro quando `"status" : "onDemand"`.
retentionInDays	inteiro <int32> >= 1 Número de dias em que a nuvem do MongoDB deve guardar o snapshot sob demanda. Deve ser pelo menos 1.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"description": "string",
"retentionInDays": 1
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

replicaSet

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

Remover um backup em nuvem de cluster fragmentado

Remove um snapshot de um cluster fragmentado do projeto especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um backup em nuvem de cluster fragmentado

Retorna um snapshot de um cluster fragmentado do projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"configServerType": "EMBEDDED",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"members": [{"cloudProvider": "AWS",
"id": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"snapshotIds": ["32b6e34b3d91647abb20e7b8"
],
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

Retornar todos os backups em nuvem de cluster fragmentado

Retorna todos os snapshots de um cluster fragmentado do projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"configServerType": "EMBEDDED",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"members": [{"cloudProvider": "AWS",
"id": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"snapshotIds": ["32b6e34b3d91647abb20e7b8"
],
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}
],
"totalCount": 0
}

Remover um backup em nuvem do conjunto de réplicas

Remove o snapshot especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um backup em nuvem do conjunto de réplicas

Retorna um snapshot do cluster especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

Alterar data de validade de um backup em nuvem

Altera a data de validade de um snapshot de backup em nuvem para um cluster no projeto especificado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Altera a data de validade de um snapshot de backup em nuvem para um cluster no projeto especificado.

retentionUnit

necessário

string

Enum: "DAYS" "WEEKS" "MONTHS" "YEARS"

Quantidade de tempo em que a nuvem do MongoDB mede a retenção de snapshots.

retentionValue

necessário

inteiro <int32>

Número que indica a quantidade de dias, semanas ou meses ou anos que o MongoDB Cloud mantém o snapshot. Para itens de política menos frequentes, o MongoDB Cloud exige que você especifique um valor maior ou igual ao valor especificado para itens de política mais frequentes. Se o item da política por hora especificar uma retenção de dois dias, especifique dois dias ou mais para a retenção do item da política semanal.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"retentionUnit": "DAYS",
"retentionValue": 5
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

Retornar todas as tarefas de restauração para uma instância sem servidor

Retorna todas as tarefas de restauração para uma instância sem servidor do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cancelled": true,
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Restaurar um snapshot de uma instância sem servidor

Restaura um snapshot de uma instância sem servidor do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor cujo snapshot você deseja restaurar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Restaura um snapshot de uma instância sem servidor do projeto especificado.

deliveryType necessário	string Enum: "automated" "download" "pointInTime" Rótulo legível por humanos que categoriza a tarefa de restauração a ser criada.
oplogInc	inteiro <int32> >= 1 Número de operação Oplog da qual você deseja restaurar esse snapshot. Esse número representa a segunda parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando `"deliveryType" : "pointInTime"` e oplogTs ultrapassam `0`.
oplogTs	inteiro <int32> >= 1199145600 Data e hora a partir das quais você deseja restaurar esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. Esse número representa a primeira parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando `"deliveryType" : "pointInTime"` e oplogTs ultrapassam `0`.
pointInTimeUTCSeconds	inteiro <int32> >= 1199145600 Data e hora em que a nuvem do MongoDB Cloud restaurou esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. O recurso retorna este parâmetro quando `"deliveryType" : "pointInTime"` e pointInTimeUTCSeconds ultrapassam `0`.
snapshotId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.
targetClusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível para humanos que identifica o cluster de destino no qual a tarefa de restauração restaura o snapshot. O recurso retorna este parâmetro quando `"deliveryType":` `"automated"`.
targetGroupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"deliveryType": "automated",
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"cancelled": true,
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

Retornar uma tarefa de restauração para uma instância sem servidor

Retorna uma tarefa de restauração para uma instância sem servidor do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica a instância sem servidor.
restoreJobId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser retornada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"cancelled": true,
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

Retornar todos os snapshots de uma instância sem servidor

Retorna todos snapshots de uma instância sem servidor do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongodVersion": "string",
"serverlessInstanceName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0
}
],
"totalCount": 0
}

Retornar um snapshot de uma instância sem servidor

Retorna um snapshot de uma instância sem servidor do projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica a instância sem servidor.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongodVersion": "string",
"serverlessInstanceName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0
}

Serviço de migração para a nuvem

Gerencia o serviço de migração para a nuvem. Organizações de origem, projetos e clusters MongoDB residem no Cloud Manager ou Ops Manager. Organizações de destino, projetos e clusters MongoDB residem no MongoDB Cloud. Bancos de dados de origem não podem usar nenhuma autenticação, exceto SCRAM-SHA.

Migrar um cluster gerenciado local para o MongoDB Atlas

Migre um cluster que o Cloud ou o Ops Manager gerencia para o MongoDB Atlas.

Não deixe de validar sua migração antes de iniciá-la.

Você pode usar esse endpoint de API apenas para migrações push em tempo real. Sua chave de API deve ter a função "Proprietário da organização" para chamar esse recurso com êxito.

NOTA: a migração de collections de séries temporais ainda não é suportada no MongoDB 6.0 ou superior. As migrações no MongoDB 6.0 ou superior ignorarão todas as collections de séries temporais no cluster de origem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Uma migração a ser criada.

necessário	objeto (Destino) Documento que descreve o destino da migração.
dropEnabled necessário	booleano Sinalizador que indica se o processo de migração descarta todas as collections do cluster de destino antes de iniciar a migração.
migrationHosts	Array de strings = 1 item Lista de hosts de migração usados para esta migração.
	objeto (ShardingRequest) Documento que configura a fragmentação no cluster de destino ao migrar de uma origem de conjunto de réplicas para um destino de cluster fragmentado no MongoDB 6.0 ou posterior. Se você não quiser fragmentar nenhuma coleção no cluster de destino, deixe em branco.
necessário	objeto (Source) Documento que descreve a origem da migração.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"destination": {"clusterName": "string",
"groupId": "9b43a5b329223c3a1591a678",
"hostnameSchemaType": "PUBLIC",
"privateLinkId": "string"
},
"dropEnabled": true,
"migrationHosts": ["vm001.example.com"
],
"sharding": {"createSupportingIndexes": true,
"shardingEntries": [{"collection": "string",
"database": "string",
"shardCollection": {"key": [{"property1": { },
"property2": { }
}
]
}
}
]
},
"source": {"caCertificatePath": "string",
"clusterName": "string",
"groupId": "9b43a5b329223c3a1591a678",
"managedAuthentication": true,
"password": "string",
"ssl": true,
"username": "string"
}
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"lagTimeSeconds": 0,
"migrationHosts": ["vm001.example.com"
],
"readyForCutover": true,
"status": "NEW"
}

Validar uma solicitação de migração

Verifica se as credenciais fornecidas, o espaço disponível em disco, as versões do MongoDB e assim por diante atendem aos requisitos da solicitação de migração. Se a verificação for aprovada, a migração poderá continuar. Sua chave de API deve ter a role Proprietário da organização para chamar esse recurso com êxito.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Uma migração a ser validada.

necessário	objeto (Destino) Documento que descreve o destino da migração.
dropEnabled necessário	booleano Sinalizador que indica se o processo de migração descarta todas as collections do cluster de destino antes de iniciar a migração.
migrationHosts	Array de strings = 1 item Lista de hosts de migração usados para esta migração.
	objeto (ShardingRequest) Documento que configura a fragmentação no cluster de destino ao migrar de uma origem de conjunto de réplicas para um destino de cluster fragmentado no MongoDB 6.0 ou posterior. Se você não quiser fragmentar nenhuma coleção no cluster de destino, deixe em branco.
necessário	objeto (Source) Documento que descreve a origem da migração.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"destination": {"clusterName": "string",
"groupId": "9b43a5b329223c3a1591a678",
"hostnameSchemaType": "PUBLIC",
"privateLinkId": "string"
},
"dropEnabled": true,
"migrationHosts": ["vm001.example.com"
],
"sharding": {"createSupportingIndexes": true,
"shardingEntries": [{"collection": "string",
"database": "string",
"shardCollection": {"key": [{"property1": { },
"property2": { }
}
]
}
}
]
},
"source": {"caCertificatePath": "string",
"clusterName": "string",
"groupId": "9b43a5b329223c3a1591a678",
"managedAuthentication": true,
"password": "string",
"ssl": true,
"username": "string"
}
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"errorMessage": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"sourceGroupId": "32b6e34b3d91647abb20e7b8",
"status": "PENDING"
}

Retornar um trabalho de validação de migração

Retornar o status de uma tarefa de validação de migração. Sua chave de API deve ter a função "Proprietário da organização" para chamar esse recurso com êxito.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

validationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 507f1f77bcf86cd799439011

String única de 24 dígitos hexadecimais que identifica a tarefa de validação.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"errorMessage": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"sourceGroupId": "32b6e34b3d91647abb20e7b8",
"status": "PENDING"
}

Retornar uma tarefa de migração

Retorne detalhes de uma tarefa de migração de cluster. Cada tarefa de migração push live usa um host de migração. Sua chave de API deve ter a role de nó da organização para chamar esse recurso corretamente.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

liveMigrationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 6296fb4c7c7aa997cf94e9a8

String exclusiva de 24 dígitos hexadecimais que identifica a migração.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
403
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"lagTimeSeconds": 0,
"migrationHosts": ["vm001.example.com"
],
"readyForCutover": true,
"status": "NEW"
}

Fazer cut over do cluster migrado

Faz o cut over do cluster migrado para o MongoDB Atlas. Confirme a conclusão do cut over. Quando o cut over for concluído, o MongoDB Atlas concluirá o processo de migração live e interromperá a sincronização com o cluster de origem. Sua chave de API deve ter a role de proprietário da organização para chamar esse recurso corretamente.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

liveMigrationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 6296fb4c7c7aa997cf94e9a8

String exclusiva de 24 dígitos hexadecimais que identifica a migração.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

400
401
403
404
500

Tipo de conteúdo

aplicação/json

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

Retornar todos os projetos disponíveis para migração

Retorne todos os projetos que você pode migrar para a organização especificada.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

[{"deployments": [{"agentVersion": "string",
"clusterId": "32b6e34b3d91647abb20e7b8",
"dbSizeBytes": 8192,
"featureCompatibilityVersion": "string",
"managed": true,
"mongoDBVersion": "string",
"name": "Project X sharded cluster",
"oplogSizeMB": 3,
"sharded": true,
"shardsSize": 3,
"tlsEnabled": true
}
],
"migrationHosts": ["string"
],
"name": "string",
"projectId": "32b6e34b3d91647abb20e7b8"
}
]

Remover um Link-Token

Remover um link da organização e sua respectiva chave de API pública. O MongoDB Atlas usa o token de link somente para migrações push em tempo real. As migrações em tempo real (push) permitem que você envie com segurança os dados do Cloud Manager ou do Ops Manager para o MongoDB Atlas. Sua chave de API deve ter a função "Proprietário da organização" para chamar esse recurso com êxito.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
400
404
500

Tipo de conteúdo

aplicação/json

{ }

Criar um Link-Token

Criar um link que contenha todas as informações necessárias para concluir o link. O MongoDB Atlas usa o token de link somente para migrações push em tempo real. A migração em tempo real (push) permite que você envie dados do Cloud Manager ou do Ops Manager com segurança para o MongoDB Atlas. Sua chave de API deve ter a função "Proprietário da organização" para chamar esse recurso com êxito.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Entradas da lista de acesso ao endereço IP associadas à migração.

accessListIps

Array de strings

Entradas da lista de acesso ao endereço IP associadas à chave de API.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"accessListIps": ["string"
]
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"linkToken": "string"
}

Acesso ao provedor de nuvem

Retorna, adiciona, autoriza e remove roles IAM da AWS no Atlas.

Retornar todas as funções de acesso do fornecedor de nuvem

Retorna todas as funções de acesso do fornecedor de nuvem com acesso ao projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"awsIamRoles": [{"providerName": "AWS",
"atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
"atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
"authorizedDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}
],
"azureServicePrincipals": [{"providerName": "AWS",
"_id": "32b6e34b3d91647abb20e7b8",
"atlasAzureAppId": "stringstringstringstringstringst",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"servicePrincipalId": "stringstringstringstringstringst",
"tenantId": "stringstringstringstringstringst"
}
]
}

Criar uma role de acesso de fornecedor de nuvem

Cria uma role de acesso para o fornecedor de nuvem especificado. Alguns recursos do MongoDB Cloud usam essas roles de acesso do fornecedor de nuvem para a autenticação. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Configurar acesso a provedores de nuvem

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria uma função para o fornecedor de nuvem especificado.

providerName

necessário

string

Rótulo legível por humanos que identifica o fornecedor de nuvem da função.

AWS

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS"
}

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
"atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
"authorizedDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

Desautorizar uma função de acesso de fornecedor de nuvem

Revoga o acesso ao projeto especificado para a função de acesso especificada. Para utilizar este recurso, a chave de API solicitante deve ter a função de Proprietário do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Enum: "AWS" "AZURE" "GCP" Rótulo legível por humanos que identifica o fornecedor de nuvem da função a ser desautorizada.
roleId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a role.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Retornar a role de acesso do fornecedor de nuvem especificado

Retorna a função de acesso com o id especificado e com acesso ao projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

roleId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica a role.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
"atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
"authorizedDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

Autorizar uma role de acesso de fornecedor de nuvem

Concede acesso ao projeto especificado para a função de acesso especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto. Esse endpoint da API é uma etapa em um procedimento para criar acesso unificado aos serviços do MongoDB Cloud. Isso não é necessário para o acesso à conta de serviço do GCP.

Configurar acesso a provedores de nuvem

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

roleId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica a role.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Concede acesso ao projeto especificado para a role de acesso especificada.

providerName necessário	string Rótulo legível por humanos que identifica o fornecedor de nuvem da função. AWS
iamAssumedRoleArn	string [ 20 ... 2048 ] caracteres Nome de recurso da Amazon (ARN) que identifica a função de gerenciamento de identidade e acesso (IAM) do Amazon Web Services (AWS) que o MongoDB Cloud considera quando acessa recursos em sua conta da AWS.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

Exemplos de resposta

200
400
404
409
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
"atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
"authorizedDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

Simulação de interrupção de cluster

Retorna, inicia ou termina uma simulação de interrupção de cluster.

Encerrar uma simulação de interrupção

Termina uma simulação de interrupção de cluster.

Simulação de interrupção de cluster

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster que está passando por simulação de interrupção.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2022-01-01T00:00:00Z",
"state": "START_REQUESTED"
}

Retornar uma simuação de interrupção

Retorna uma simulação de interrupção para um cluster.

Simulação de interrupção de cluster

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster que está passando por simulação de interrupção.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2022-01-01T00:00:00Z",
"state": "START_REQUESTED"
}

Iniciar uma simulação de interrupção

Inicia uma simulação de interrupção de cluster.

Simulação de interrupção de cluster

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster que passará por uma simulação de interrupção.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Descreve a simulação de interrupção.

Array de objetos (AtlasClusterOutageSimulationOutageFilter) non-empty

Lista de configurações que especificam o tipo de simulação de interrupção de cluster.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
]
}

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2022-01-01T00:00:00Z",
"state": "START_REQUESTED"
}

Clusters

Retorna, adiciona, edita e remove implantações do banco de dados. Alterações nas configurações do cluster podem afetar os custos. Esse recurso requer seu ID do projeto.

Retornar todos os clusters autorizados em todos os projetos

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 este recurso, a chave de API solicitante pode ter qualquer role no nível do cluster.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

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

Retornar todos os clusters em um projeto

Retorna os detalhes de todos os clusters do projeto específico ao qual 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 multi-cloud. Para retornar clusters multi-cloud, use Obter todos os clusters avançados. Para usar esse recurso, a chave da API solicitante deve ter o role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
includeDeletedWithRetainedBackups	booleano Padrão: false Sinalizador que indica se clusters com backups retidos devem ser retornados.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
],
"totalCount": 0
}

Criar um cluster

Cria um cluster no projeto específico. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Este recurso não cria clusters multicloud. Para criar um cluster multi-cloud, use Criar um cluster avançado. Para utilizar esse recurso, a chave de API solicitante deve ter o role de proprietário do projeto.

Quando você implanta um cluster dedicado M10+, o Atlas cria uma VPC para o provedor selecionado e a região ou regiões se não houver nenhuma conexão de emparelhamento de VPC ou VPC para esse provedor e região. O Atlas atribui à VPC um bloco de roteamento interdomínio sem classes (CIDR).

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes para criar para um cluster no projeto especificado.

acceptDataRisksAndForceReplicaSetReconfig	string <date-time> Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional, envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupções regionais. Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os documentos do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Reconfiguração de um conjunto de réplicas durante uma interrupção regional
	objeto (Configurações automáticas de dimensionamento de cluster) Faixa de tamanhos de instâncias para os quais seu cluster pode ser dimensionado. Escalonamento automático de cluster
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.
	objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. MongoDB Connector para Business Intelligence
clusterType	string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster.
configServerManagementMode	string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. Servidores de configuração de cluster fragmentado do MongoDB
diskSizeGB	número <double> [ 10 .. 4096 ] Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade. Este valor não é configurável em clusters M0/M2/M5 . O MongoDB Cloud exige este parâmetro se você definir replicationSpecs. Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco. Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado. O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.
diskWarmingMode	string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. Reduza o impacto do aquecimento do disco secundário
encryptionAtRestProvider	string Enum: "NONE" "AWS" "AZURE" "GCP" Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para oferecer uma camada adicional de Encryption at Rest para o cluster. Criptografia em repouso usando o gerenciamento de chaves de cliente
globalClusterSelfManagedSharding	booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. Criando um cluster global
	Array de objetos (Etiqueta do componente) Obsoleto(a) Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos. As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Recomendamos fortemente que você use marcações de recursos.
mongoDBMajorVersion	string Versão principal do MongoDB do cluster. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. Versões do MongoDB disponíveis no Atlas
Versão do MongoDB	string([\d]+\.[\d]+\.[\d]+) Versão do MongoDB que o cluster executa.
name	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
numShards	inteiro <int32> [ 1 .. 50 ] Padrão: 1 Número de fragmentos até 50 a serem implantados em um cluster fragmentado. O recurso retorna `1` para indicar um conjunto de réplica e valores de `2` e superior para indicar um cluster fragmentado. O valor retornado é igual ao número de fragmentos do cluster. Fragmentação
pausado	booleano Sinalizador que indica se o cluster está pausado.
pitEnabled	booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. Backups contínuos da nuvem
providerBackupEnabled	booleano Sinalizador que indica se o cluster M10 ou superior pode executar backups em nuvem. Se configurado para `true`, o cluster poderá executar backups. Se isso e backupEnabled estiverem definidos como `false`, o cluster não usará backups do MongoDB Cloud.
	objeto (Configurações do fornecedor de serviços em nuvem para um cluster) Grupo de configurações do fornecedor de nuvem que configuram os hosts MongoDB provisionados.
replicaSetScalingStrategy	string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. Modifique o modo de dimensionamento do conjunto de réplicas
Fator de replicação	inteiro <int32> Obsoleto(a) Padrão: 3 Enum: 3 5 7 Número de nós que pertencem ao conjunto de réplicas. Cada nó mantém uma cópia dos seus bancos de dados, proporcionando uma alta disponibilidade e uma redundância de dados. Em vez disso, use replicationSpecs.
	objeto (Configuração da região) Local físico onde o MongoDB Cloud provisiona nós de cluster.
	Array de objetos (LegacyReplicationSpec) Lista de configurações que definem suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde o MongoDB Cloud implanta seus nós de clusters. Para conjuntos de réplicas e clusters fragmentados não globais, o objeto único representa onde o MongoDB Cloud implanta seus nós de clusters.
rootCertType	string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificado raiz que os clusters do MongoDB Atlas utiliza. O MongoDB Cloud aceita a Internet Security Research Group.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Resource Tags
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como `true`, o MongoDB Cloud não excluirá o cluster. Se definido como `false`, o MongoDB Cloud excluirá o cluster.
versionReleaseSystem	string Padrão: "LTS" Enum: "LTS" "CONTINUOUS" Método pelo qual o cluster mantém as versões do MongoDB. Se o valor for `CONTINUOUS`, você não deverá especificar mongoDBMajorVersion.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Retornar todas as regiões de fornecedor de nuvem

Retorna a lista de regiões disponíveis para o fornecedor de nuvem especificado na camada especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
providers	Array de strings Fornecedor de nuvem cujas regiões serão recuperadas. Quando você especifica vários fornecedores, a resposta pode retornar apenas camadas e regiões que aceitam clusters de várias nuvens.
nível	string Camada do cluster para a qual recuperar as regiões.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"instanceSizes": [{"availableRegions": [{"default": true,
"name": "string"
}
],
"name": "string"
}
],
"provider": "AWS"
}
],
"totalCount": 0
}

Atualizar um cluster de nível compartilhado

Atualiza um cluster de camada compartilhada no projeto especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de gerenciador de cluster de projeto. Cada projeto aceita até 25 clusters.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes da atualização do agrupamento de camada compartilhada no projeto especificado.

acceptDataRisksAndForceReplicaSetReconfig	string <date-time> Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional, envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupções regionais. Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os documentos do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Reconfiguração de um conjunto de réplicas durante uma interrupção regional
	objeto (Configurações automáticas de dimensionamento de cluster) Faixa de tamanhos de instâncias para os quais seu cluster pode ser dimensionado. Escalonamento automático de cluster
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.
	objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. MongoDB Connector para Business Intelligence
clusterType	string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster.
configServerManagementMode	string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. Servidores de configuração de cluster fragmentado do MongoDB
diskSizeGB	número <double> [ 10 .. 4096 ] Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade. Este valor não é configurável em clusters M0/M2/M5 . O MongoDB Cloud exige este parâmetro se você definir replicationSpecs. Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco. Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado. O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.
diskWarmingMode	string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. Reduza o impacto do aquecimento do disco secundário
encryptionAtRestProvider	string Enum: "NONE" "AWS" "AZURE" "GCP" Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para oferecer uma camada adicional de Encryption at Rest para o cluster. Criptografia em repouso usando o gerenciamento de chaves de cliente
globalClusterSelfManagedSharding	booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. Criando um cluster global
	Array de objetos (Etiqueta do componente) Obsoleto(a) Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos. As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Recomendamos fortemente que você use marcações de recursos.
mongoDBMajorVersion	string Versão principal do MongoDB do cluster. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. Versões do MongoDB disponíveis no Atlas
Versão do MongoDB	string([\d]+\.[\d]+\.[\d]+) Versão do MongoDB que o cluster executa.
name necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
numShards	inteiro <int32> [ 1 .. 50 ] Padrão: 1 Número de fragmentos até 50 a serem implantados em um cluster fragmentado. O recurso retorna `1` para indicar um conjunto de réplica e valores de `2` e superior para indicar um cluster fragmentado. O valor retornado é igual ao número de fragmentos do cluster. Fragmentação
pausado	booleano Sinalizador que indica se o cluster está pausado.
pitEnabled	booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. Backups contínuos da nuvem
providerBackupEnabled	booleano Sinalizador que indica se o cluster M10 ou superior pode executar backups em nuvem. Se configurado para `true`, o cluster poderá executar backups. Se isso e backupEnabled estiverem definidos como `false`, o cluster não usará backups do MongoDB Cloud.
	objeto (Configurações do fornecedor de serviços em nuvem para um cluster) Grupo de configurações do fornecedor de nuvem que configuram os hosts MongoDB provisionados.
replicaSetScalingStrategy	string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. Modifique o modo de dimensionamento do conjunto de réplicas
Fator de replicação	inteiro <int32> Obsoleto(a) Padrão: 3 Enum: 3 5 7 Número de nós que pertencem ao conjunto de réplicas. Cada nó mantém uma cópia dos seus bancos de dados, proporcionando uma alta disponibilidade e uma redundância de dados. Em vez disso, use replicationSpecs.
	objeto (Configuração da região) Local físico onde o MongoDB Cloud provisiona nós de cluster.
	Array de objetos (LegacyReplicationSpec) Lista de configurações que definem suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde o MongoDB Cloud implanta seus nós de clusters. Para conjuntos de réplicas e clusters fragmentados não globais, o objeto único representa onde o MongoDB Cloud implanta seus nós de clusters.
rootCertType	string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificado raiz que os clusters do MongoDB Atlas utiliza. O MongoDB Cloud aceita a Internet Security Research Group.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Resource Tags
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como `true`, o MongoDB Cloud não excluirá o cluster. Se definido como `false`, o MongoDB Cloud excluirá o cluster.
versionReleaseSystem	string Padrão: "LTS" Enum: "LTS" "CONTINUOUS" Método pelo qual o cluster mantém as versões do MongoDB. Se o valor for `CONTINUOUS`, você não deverá especificar mongoDBMajorVersion.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Atualiza um cluster de nível compartilhado para a instância sem servidor

Atualiza um cluster de nível compartilhado para uma instância sem servidor no projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Gerenciador de cluster do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes da atualização do agrupamento de camada compartilhada no projeto especificado.

name	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica a instância sem servidor.
necessário	objeto (Configurações do fornecedor de serviços em nuvem para uma instância sem servidor) Grupo de configurações do fornecedor de nuvem que definem a instância sem servidor do MongoDB provisionada.
	objeto (Opções de backup sem servidor) Grupo de configurações que configuram o backup sem servidor.
	Array de objetos (Tag do recurso) Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância sem servidor.
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada na instância sem servidor. Se definido para `true`, o MongoDB Cloud não excluirá a instância sem servidor. Se definido para `false`, o MongoDB Cloud excluirá a instância sem servidor.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Remover um cluster

Remove um cluster no projeto específico. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A proteção do cluster contra encerramento deve estar desabilitada para que ele possa ser excluído. Para utilizar esse recurso, a chave de API solicitante deve ter o role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
retainBackups	booleano Sinalizador que indica se deseja manter snapshots de backup para o cluster dedicado excluído.

Respostas

Exemplos de resposta

400
401
404
409
500

Tipo de conteúdo

aplicação/json

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

Retornar um cluster em um projeto

Retorna os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta não inclui clusters multi-cloud. Para retornar um cluster multi-cloud, use Obter um cluster avançado. Para usar esse recurso, a chave da API solicitante deve ter o role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
409
500

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Atualizar configuração de um cluster

Atualize os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Este recurso não atualiza clusters multicloud. Para atualizar um cluster multi-cloud, use Atualizar um cluster avançado. Você pode atualizar o cluster apenas uma versão principal por vez. You can't skip any major versions. Cada versão principal contém alguns recursos que podem não ser compatíveis com versões anteriores. Check the Release Notes for changes that might affect your applications. Depois de atualizar a versão principal do MongoDB, você não poderá fazer downgrade para versões anteriores.

A partir da versão 4.2 do MongoDB, os backups de legado foram preteridos em favor dos backups de cloud. Quando você faz upgrade para a versão 4,2 ou posterior, seu sistema de backup é atualizado para Backups em Nuvem se estiver atualmente definido como Backup Legado. Após esta atualização, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups de legado, será necessário recriá-la seguindo o procedimento descrito na documentação de cloud Backup.

Para utilizar este recurso, a chave de API solicitante deve ter a role de gerenciador de cluster de projeto. Este recurso não está disponível para M0 clusters gratuitos do e clustersM2 M5 de nível compartilhado do e .

O número total de nós em clusters que abrangem regiões tem uma restrição específica por projeto. O MongoDB cloud limita o número total de nós em outras regiões em um projeto a um total de 40. Esse total exclui as regiões do GCP que se comunicam entre si, clusters gratuitos ou cluster compartilhado. O número total de nós entre quaisquer duas regiões deve atender a essa restrição. Por exemplo, se um projeto tiver nós em clusters espalhados por três regiões: 30 nós na região A, 10 nós na região B e 5 nós na região C, você poderá adicionar apenas mais 5 nós à região C porque, se excluir a região C , Região A + Região B = 40. Se você excluir a região B, região A + região C = 35, <= 40. Se você excluir a região A, região B + região C = 15, <= 40. Cada combinação de regiões com os 5 nós adicionados ainda atende à restrição por projeto: Região A + B = 40, Região A + C = 40 e Região B + C = 20. Você não pode criar um cluster multirregional em um projeto se ele tiver um ou mais clusters abrangendo 40 ou mais nós em outras regiões.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes a serem atualizados para um cluster no projeto especificado.

acceptDataRisksAndForceReplicaSetReconfig	string <date-time> Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional, envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupções regionais. Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os documentos do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Reconfiguração de um conjunto de réplicas durante uma interrupção regional
	objeto (Configurações automáticas de dimensionamento de cluster) Faixa de tamanhos de instâncias para os quais seu cluster pode ser dimensionado. Escalonamento automático de cluster
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.
	objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. MongoDB Connector para Business Intelligence
clusterType	string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster.
configServerManagementMode	string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. Servidores de configuração de cluster fragmentado do MongoDB
diskSizeGB	número <double> [ 10 .. 4096 ] Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade. Este valor não é configurável em clusters M0/M2/M5 . O MongoDB Cloud exige este parâmetro se você definir replicationSpecs. Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco. Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado. O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.
diskWarmingMode	string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. Reduza o impacto do aquecimento do disco secundário
encryptionAtRestProvider	string Enum: "NONE" "AWS" "AZURE" "GCP" Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para oferecer uma camada adicional de Encryption at Rest para o cluster. Criptografia em repouso usando o gerenciamento de chaves de cliente
globalClusterSelfManagedSharding	booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. Criando um cluster global
	Array de objetos (Etiqueta do componente) Obsoleto(a) Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos. As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Recomendamos fortemente que você use marcações de recursos.
mongoDBMajorVersion	string Versão principal do MongoDB do cluster. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. Versões do MongoDB disponíveis no Atlas
Versão do MongoDB	string([\d]+\.[\d]+\.[\d]+) Versão do MongoDB que o cluster executa.
name	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
numShards	inteiro <int32> [ 1 .. 50 ] Padrão: 1 Número de fragmentos até 50 a serem implantados em um cluster fragmentado. O recurso retorna `1` para indicar um conjunto de réplica e valores de `2` e superior para indicar um cluster fragmentado. O valor retornado é igual ao número de fragmentos do cluster. Fragmentação
pausado	booleano Sinalizador que indica se o cluster está pausado.
pitEnabled	booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. Backups contínuos da nuvem
providerBackupEnabled	booleano Sinalizador que indica se o cluster M10 ou superior pode executar backups em nuvem. Se configurado para `true`, o cluster poderá executar backups. Se isso e backupEnabled estiverem definidos como `false`, o cluster não usará backups do MongoDB Cloud.
	objeto (Configurações do fornecedor de serviços em nuvem para um cluster) Grupo de configurações do fornecedor de nuvem que configuram os hosts MongoDB provisionados.
replicaSetScalingStrategy	string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. Modifique o modo de dimensionamento do conjunto de réplicas
Fator de replicação	inteiro <int32> Obsoleto(a) Padrão: 3 Enum: 3 5 7 Número de nós que pertencem ao conjunto de réplicas. Cada nó mantém uma cópia dos seus bancos de dados, proporcionando uma alta disponibilidade e uma redundância de dados. Em vez disso, use replicationSpecs.
	objeto (Configuração da região) Local físico onde o MongoDB Cloud provisiona nós de cluster.
	Array de objetos (LegacyReplicationSpec) Lista de configurações que definem suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde o MongoDB Cloud implanta seus nós de clusters. Para conjuntos de réplicas e clusters fragmentados não globais, o objeto único representa onde o MongoDB Cloud implanta seus nós de clusters.
rootCertType	string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificado raiz que os clusters do MongoDB Atlas utiliza. O MongoDB Cloud aceita a Internet Security Research Group.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Resource Tags
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como `true`, o MongoDB Cloud não excluirá o cluster. Se definido como `false`, o MongoDB Cloud excluirá o cluster.
versionReleaseSystem	string Padrão: "LTS" Enum: "LTS" "CONTINUOUS" Método pelo qual o cluster mantém as versões do MongoDB. Se o valor for `CONTINUOUS`, você não deverá especificar mongoDBMajorVersion.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"autoScaling": {"compute": {"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Retornar opções de uma configuração avançada para um cluster

Retorna os detalhes de configuração avançada para um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Detalhes de configuração avançada incluem read/write concern, limites de índice e oplog e outras configurações do banco de dados. Este recurso não está disponível para clusters gratuitos do M0, clusters de nível compartilhado do M2 e M5 ou clusters sem servidor. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"defaultMaxTimeMS": 0,
"defaultReadConcern": "local",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"transactionLifetimeLimitSeconds": 1
}

Atualizar opções de configuração avançadas para um cluster

Atualiza os detalhes de configuração avançada para um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Detalhes de configuração avançada incluem read/write concern, limites de índice e oplog e outras configurações do banco de dados. Para utilizar este recurso, a chave de API solicitante deve possuir a role de Gerenciador de cluster de projeto. Este recurso não está disponível para clusters gratuitos do M0, clusters de nível compartilhado do M2 e M5 ou clusters sem servidor.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes de configuração avançados para adicionar a um cluster no projeto especificado.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds	inteiro <int32> Padrão: -1 O tempo mínimo de retenção pré e pós-imagem em segundos. Esta opção corresponde ao ''changeStreamOptions.preAndPostImages.expireAfterSeconds'' Parâmetro do cluster. Essa configuração controla a política de retenção das imagens antes e depois do fluxo de alterações. Pré e pós-imagens são as versões de um documento antes e depois da modificação do documento, respectivamente. "expireAfterSeconds" controla por quanto tempo o MongoDB retém as imagens pré e pós-imagens. Quando definido como -1 (off), o MongoDB usa a política de retenção padrão: as imagens pré e pós-imagens são retidas até que os eventos de fluxo de alterações correspondentes sejam removidos do oplog. Para definir o tempo mínimo de retenção pré e pós-imagem, especifique um valor inteiro maior que zero. Definir isso muito baixo pode aumentar o risco de interromper a sincronização do Realm ou acionar o processamento. O valor padrão é -1 (desligado).
chunkMigrationConcurrency	inteiro <int32> Número de segmentos no fragmento de origem e no fragmento de recebimento para migração de partes. O número de segmentos não deve exceder a metade do número total de núcleos da CPU do cluster fragmentado. Esta opção corresponde à opção de arquivo de configuração 'chunkMigrationConcurrency' 'mongod'.
defaultMaxTimeMS	inteiro <int32> Limite de tempo padrão em milissegundos para a conclusão de operações de leitura individuais. Esta opção corresponde ao parâmetro de cluster defaultmaxTimeMS.
defaultReadConcern	string Padrão: "available" Enum: "local" "available" Nível padrão de confirmação solicitado pelo MongoDB para operações de leitura definidas para o cluster. Os clusters MongoDB 4.4 são padronizados como `available`. Os clusters do MongoDB 5.0 e posterior são padronizados como `local`. Esta opção corresponde à read concern de padrão global.
defaultWriteConcern	string Nível padrão de confirmação de solicitado pelo MongoDB para operações de gravação quando nenhuma é especificada pelo driver. Essa opção corresponde à preocupação implícita de write concern.
failIndexKeyTooLong	booleano Obsoleto(a) Padrão: true Sinalizador que indica se você pode inserir ou atualizar documentos em que todas as entradas indexadas não excedam 1024 bytes. Se você definir essa opção como falsa, o mongod gravará os documentos que excederem esse limite, mas não os indexará. Este parâmetro foi removido a partir do MongoDB 4.4. Esta opção corresponde à opção do arquivo de configuração `failIndexKeyTooLong' `mongod'.
javascriptEnabled	booleano Sinalizador que indica se o cluster permite a execução de operações que realizam execuções em JavaScript no lado do servidor. Ao usar 8.0+, recomendamos desabilitar o JavaScript do lado do servidor e usar operadores de pipeline de agregação como alternativa de melhor desempenho. Esta opção corresponde à modificação da opção de arquivo de configuração do security.javascriptEnabled` para cada `mongod' e `mongos' no cluster.
minimumEnabledTlsProtocol	string Enum: "TLS1_0" "TLS1_1" "TLS1_2" Versão TLS (Transport Layer Security) mínima que o cluster aceita para conexões de entrada. Para clusters que usam TLS 1.0 ou 1.1, recomendamos definir o TLS 1.2 como a versão mínima do protocolo TLS. Esta opção corresponde ao 'net.ssl.disabledProtocols' Opção de arquivo de configuração 'mongod'.
noTableScan	booleano Flag que indica se o cluster desativa a execução de qualquer query que exija uma varredura de coleção para retornar resultados. Esta opção corresponde à opção do arquivo de configuração `notablescan' `mongod'.
oplogMinRetentionHours	número ou nulo <double> Janela mínima de retenção para o oplog do cluster expressa em horas. Um valor nulo indica que o cluster usa a janela de oplog mínima padrão que o MongoDB Cloud calcula. Esta opção corresponde ao arquivo `storage.oplogMinRetentionHours' Opção de arquivo de configuração `mongod`.
oplogSizeMB	inteiro ou nulo <int32> Limite de armazenamento do oplog do cluster expresso em megabytes. Um valor nulo indica que o cluster usa o tamanho de oplog padrão que a Nuvem MongoDB calcula. Esta opção corresponde ao 'replication.oplogSizeMB' Opção de arquivo de configuração 'mongod'.
queryStatsLogVerbosity	inteiro <int32> Pode ser definido como 1 (desabilitado) ou 3 (habilitado). Quando definido como 3, o Atlas incluirá a saída $queryStats ocultada e anonimizada nos registros do MongoDB. A saída $queryStats não contém literais ou valores de campo. Habilitar essa configuração pode afetar o desempenho do seu cluster. Esta opção corresponde ao componente queryStats para o parâmetro do servidor logComponentVerbosity.
sampleRefreshIntervalBIConnector	inteiro <int32> > = 0 Padrão: 0 Intervalo em segundos no qual o processo mongosqld faz uma nova amostra dos dados para criar seu esquema relacional. Esta opção corresponde a `sampleRefreshIntervalSecs' `mongosqld'.
sampleSizeBIConnector	inteiro <int32> > = 0 Número de documentos por banco de dados a serem amostrados ao coletar informações de esquema. Esta opção corresponde a `sampleSize' `mongosqld'.
transactionLifetimeLimitSeconds	inteiro <int64> >= 1 Vida útil, em segundos, de transações multidocumento. O Atlas considera as transações que excedem esse limite como expiradas e, portanto, as aborta por meio de um processo de limpeza periódico. Esta opção corresponde à opção do arquivo de configuração `transactionLifetimeLimitSeconds' `mongod'.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"defaultMaxTimeMS": 0,
"defaultReadConcern": "local",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"transactionLifetimeLimitSeconds": 1
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"defaultMaxTimeMS": 0,
"defaultReadConcern": "local",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"transactionLifetimeLimitSeconds": 1
}

Testar failover para um cluster

Inicia um teste de failover para o cluster especificado no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Um teste de failover verifica como o MongoDB Cloud administra a falha do nó primário do cluster. Durante o teste, o MongoDB Cloud desliga o nó primário e elege um novo primário. Para utilizar este recurso, a chave de API solicitante deve ter a função de gerenciador de cluster de projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

401
500

Tipo de conteúdo

aplicação/json

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

Status de retorno de todas as operações de cluster

Retorna o status de todas as alterações que você fez no cluster especificado no projeto especificado. Use esse recurso para verificar o progresso que o MongoDB Cloud fez no processamento de suas alterações. A resposta não inclui a implantação de novos clusters dedicados. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"changeStatus": "PENDING",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Carregar solicitação de conjunto de dados de amostra no cluster

Solicitações carregando o conjunto de dados de amostra MongoDB no agrupamento especificado. Para utilizar este recurso, a chave de API solicitante deve possuir a função de Proprietário do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

name

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica o cluster no qual você carrega o conjunto de dados de amostra.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

201
400
404
409
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"completeDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"state": "WORKING"
}

Verificar o status da solicitação de conjunto de dados de amostra de cluster

Confere o progresso do carregamento do conjunto de dados de amostra em um cluster. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

sampleDatasetId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Cadeia exclusiva de 24 dígitos hexadecimais que identifica o conjunto de dados de amostra carregado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"completeDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"errorMessage": "string",
"state": "WORKING"
}

Papéis do Banco de Dados Personalizado

Retorna, adiciona, edita e remove roles de privilégio de usuário de bancos de dados personalizados. Use roles personalizadas para especificar conjuntos personalizados de ações que as funções integradas do MongoDB Cloud não conseguem descrever. Você define roles personalizadas no nível do projeto, para todos os clusters no projeto. Este recurso aceita um subconjunto de ações de privilégio do MongoDB. Você pode criar um subconjunto de ações de roles personalizadas. Para criar uma lista mais ampla de ações de roles personalizadas, use a interface de usuário do MongoDB Cloud. As roles personalizadas devem incluir ações aceitas por todos os clusters do projeto, e que sejam compatíveis com cada versão do MongoDB que os clusters do seu projeto utilizam. Por exemplo, se seu projeto tiver clusters MongoDB 4.2, você não poderá criar roles personalizadas que usem ações introduzidas no MongoDB 4.4.

Retornar todas as funções personalizadas em um projeto

Retornar todas as funções personalizadas para o projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

[{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}
]

Criar uma função personalizada

Cria uma role personalizada no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria uma função personalizada no projeto especificado.

	Array de objetos (Ação de privilégio do banco de dados) Lista das ações de privilégio específicas que a função concede.
	Array de objetos (Role herdada) unique Lista das funções incorporadas que esta função personalizada herda.
roleName necessário	string Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

Remover uma função personalizada de um projeto

Remove uma função personalizada do projeto especificado. Não é possível remover uma role personalizada que deixaria uma ou mais roles secundárias sem roles ou ações principais. Também não é possível remover uma role personalizada que deixaria um ou mais usuários do banco de dados sem roles. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador do projeto do Atlas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

roleName

necessário

string

Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

400
401
404
409
500

Tipo de conteúdo

aplicação/json

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

Retornar uma função personalizada em um projeto

Retorna uma role personalizada para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

roleName

necessário

string

Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

Atualizar uma função personalizada em um projeto

Atualiza uma role personalizada no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

roleName

necessário

string

Etiqueta legível para humanos que identifica a role da solicitação. Este nome deve ser exclusivo para essa role personalizada neste projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza uma função personalizada no projeto especificado.

	Array de objetos (Ação de privilégio do banco de dados) Lista das ações de privilégio específicas que a função concede.
	Array de objetos (Role herdada) unique Lista das funções incorporadas que esta função personalizada herda.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
]
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

Federação de Dados

Retorna, adiciona, edita e remove instâncias de bancos de dados federados. Este recurso requer o ID do seu projeto. As alterações nas configurações da instância do banco de dados federado podem afetar os custos.

Retornar todas as instâncias de banco de dados federadas em um projeto

Retorna os detalhes de todas as instâncias do banco de dados federado no projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a função de Somente Leitura do Projeto ou superior.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
type	string Padrão: "USUÁRIO" Enum: "USUÁRIO" "ONLINE_ARCHIVE" Tipo de instâncias do banco de dados federado a serem retornadas.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

[{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "string"
},
"azure": {"atlasAppId": "string",
"roleId": "string",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": [null
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}
]

Criar uma instância do banco de dados federado em um projeto

Cria uma instância do banco de dados federado no projeto especificado. Para usar esse recurso, a chave API solicitante deve ter as roles de Proprietário do projeto ou Administrador de gráficos do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
skipRoleValidation	booleano Padrão: false Sinalizador que indica se essa solicitação deve verificar se a role do IAM solicitante pode ler a partir do bucket do S3. A AWS verifica se a role pode listar os objetos no bucket antes de gravar nele. Algumas roles do IAM precisam apenas de permissões de gravação. Este sinalizador permite pular essa verificação.

Esquema do corpo da solicitação: application/json

Detalhes para criar uma instância do banco de dados federado no projeto especificado.

	objeto (Fornecedor de nuvem de federação de dados) Provedor de nuvem em que essa instância de banco de dados federado está hospedada.
	objeto (DataLakeDataProcessRegion) Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.
name	string Etiqueta legível por humanos que identifica a instância do banco de dados federado.
	objeto (DataLakeStorage) Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"cloudProviderConfig": {"aws": {"roleId": "string",
"testS3Bucket": "string"
},
"azure": {"roleId": "string"
},
"gcp": {"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"name": "string",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

Exemplos de resposta

200
400
500

Tipo de conteúdo

aplicação/json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "string"
},
"azure": {"atlasAppId": "string",
"roleId": "string",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

Remover uma instância de banco de dados federada de um projeto

Remove uma instância do banco de dados federado do projeto especificado. Para usar esse recurso, a chave API solicitante deve ter as roles de Proprietário do projeto ou Administrador de gráficos do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Etiqueta legível para humanos que identifica a instância do banco de dados federado a ser removido.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma instância do banco de dados federado em um projeto

Retorna os detalhes de uma instância do banco de dados federado dentro do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter as roles de somente leitura do projeto ou administrador de gráficos do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Etiqueta legível por humanos que identifica o Banco de Dados Federado a retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "string"
},
"azure": {"atlasAppId": "string",
"roleId": "string",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

Atualizar uma instância do banco de dados federado em um projeto

Atualiza os detalhes de uma instância do banco de dados federado no projeto especificado. Para utilizar este recurso, a chave de API solicitante deve possuir a função de Proprietário do Projeto ou superior.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Rótulo legível por humanos que identifica a instância do banco de dados federado que será atualizada.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
skipRoleValidation necessário	booleano Sinalizador que indica se essa solicitação deve verificar se a role do IAM solicitante pode ler a partir do bucket do S3. A AWS verifica se a role pode listar os objetos no bucket antes de gravar nele. Algumas roles do IAM precisam apenas de permissões de gravação. Este sinalizador permite pular essa verificação.

Esquema do corpo da solicitação: application/json

Detalhes de um banco de dados federado a ser atualizado no projeto especificado.

	objeto (Fornecedor de nuvem de federação de dados) Provedor de nuvem em que essa instância de banco de dados federado está hospedada.
	objeto (DataLakeDataProcessRegion) Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.
name	string Etiqueta legível por humanos que identifica a instância do banco de dados federado.
	objeto (DataLakeStorage) Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"cloudProviderConfig": {"aws": {"roleId": "string",
"testS3Bucket": "string"
},
"azure": {"roleId": "string"
},
"gcp": {"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"name": "string",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "string"
},
"azure": {"atlasAppId": "string",
"roleId": "string",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "string"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

Retornar todos os limites de consulta para uma instância de banco de dados federada

Retorna limites de consulta para uma instância de bancos de dados federados no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Etiqueta legível para humanos que identifica a instância do banco de dados federado para a qual você deseja recuperar os limites de query.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

[{"currentUsage": 0,
"defaultLimit": 0,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"maximumLimit": 0,
"name": "string",
"overrunPolicy": "BLOCK",
"tenantName": "string",
"value": 0
}
]

Excluir um limite de query para uma instância do banco de dados federado

Exclui um limite de query para uma instância do banco de dados federado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Rótulo legível por humanos que identifica a instância do banco de dados federado à qual o limite de consulta se aplica.

limitName

necessário

string

Enum: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

Etiqueta legível para humanos que identifica este limite de instância de Data Federation.

Nome do limite	Descrição	Default
bytesProcessed.query	Limite do número de bytes processados durante uma única query de federação de dados	N/A
bytesProcessed.daily	Limite do número de bytes processados para a instância de federação de dados para o dia atual	N/A
bytesProcessed.weekly	Limite do número de bytes processados para a instância de federação de dados da semana vigente	N/A
bytesProcessed.monthly	Limite do número de bytes processados para a instância de federação de dados do mês vigente	N/A

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
400
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um limite de query de instância do banco de dados federado para um projeto

Retorna os detalhes de um limite de query para a instância do banco de dados federado especificada no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Rótulo legível por humanos que identifica a instância do banco de dados federado à qual o limite de consulta se aplica.

limitName

necessário

string

Enum: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

Etiqueta legível para humanos que identifica este limite de instância de Data Federation.

Nome do limite	Descrição	Default
bytesProcessed.query	Limite do número de bytes processados durante uma única query de federação de dados	N/A
bytesProcessed.daily	Limite do número de bytes processados para a instância de federação de dados para o dia atual	N/A
bytesProcessed.weekly	Limite do número de bytes processados para a instância de federação de dados da semana vigente	N/A
bytesProcessed.monthly	Limite do número de bytes processados para a instância de federação de dados do mês vigente	N/A

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"currentUsage": 0,
"defaultLimit": 0,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"maximumLimit": 0,
"name": "string",
"overrunPolicy": "BLOCK",
"tenantName": "string",
"value": 0
}

Configurar um limite de consulta para uma instância de banco de dados federada

Cria ou atualiza um limite de consulta para uma instância do banco de dados federado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Rótulo legível por humanos que identifica a instância do banco de dados federado à qual o limite de consulta se aplica.

limitName

necessário

string

Enum: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

Etiqueta legível para humanos que identifica este limite de instância de Data Federation.

Nome do limite	Descrição	Default
bytesProcessed.query	Limite do número de bytes processados durante uma única query de federação de dados	N/A
bytesProcessed.daily	Limite do número de bytes processados para a instância de federação de dados para o dia atual	N/A
bytesProcessed.weekly	Limite do número de bytes processados para a instância de federação de dados da semana vigente	N/A
bytesProcessed.monthly	Limite do número de bytes processados para a instância de federação de dados do mês vigente	N/A

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Cria ou atualiza um limite de query para uma instância do banco de dados federado.

overrunPolicy	string Enum: "BLOCK" "BLOCK_AND_KILL" Usado apenas para limites do Data Federation. Ação a ser tomada quando o limite de uso for excedido. Se a extensão limite for definida como QUERY, isso será ignorado porque o MongoDB Cloud interromperá a query quando ela exceder o limite de uso.
valor necessário	inteiro <int64> Valor da definição do limite.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"overrunPolicy": "BLOCK",
"value": 0
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"currentUsage": 0,
"defaultLimit": 0,
"lastModifiedDate": "2019-08-24T14:15:22Z",
"maximumLimit": 0,
"name": "string",
"overrunPolicy": "BLOCK",
"tenantName": "string",
"value": 0
}

Baixar registros de query para uma instância do banco de dados federado

Baixa os registros de consulta da instância do banco de dados federado especificado. Para usar esse recurso, a chave de API solicitante deve ter as funções "Proprietário do projeto" ou "Acesso de gravação/leitura aos dados do projeto". A API não suporta chamadas diretas com o esquema de resposta JSON . Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/gzip".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

tenantName

necessário

string

Etiqueta legível para humanos que identifica a instância do banco de dados federado para a qual você deseja baixar os registros de query.

parâmetros de query

endDate	inteiro <int64> 1199145600 Exemplo: endDate=1636481348 Registro de data/hora que especifica o ponto de término para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch.
startDate	inteiro <int64> 1199145600 Exemplo: startDate=1636466948 Registro de data/hora que especifica o ponto de início para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

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

Retornar todos os endpoints privados de instância de banco de dados federado e Online Archive em um projeto

Retorna todos os endpoints privados para instâncias de banco de dados federado e arquivos on-line no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter as funções "somente leitura" do projeto ou "Administrador de gráficos do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"azureConnectionName": "string",
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 0
}

Criar uma instância de banco de dados federada e endpoint privado de arquivamento on-line para um projeto

Adiciona um endpoint privado para instâncias do banco de dados federados e Online Archives nos projetos especificados. Se o ID do endpoint já existir e o comentário associado não for alterado, o Atlas Data Federation não fará nenhuma alteração na lista de IDs do endpoint. Se o ID do endpoint já existir e o comentário associado for alterado, o Atlas Data Federation atualizará o valor do comentário somente na lista de IDs do endpoint. Se o ID do endpoint não existir, o Atlas Data Federation anexará o novo endpoint à lista de endpoints na lista de IDs de endpoints. Cada região tem um nome de serviço associado para os diversos endpoints em cada região.

us-east-1 é com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4.

us-west-1 é com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb.

eu-west-1 é com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e.

eu-west-2 é com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9.

eu-central-1 é com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d.

sa-east-1 é com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044.

ap-southeast-2 é com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e.

ap-south-1 é com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d.

Para usar esse recurso, a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de gráficos do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Endpoint privado para instâncias do banco de dados federados e Online Archives para adicionar ao projeto especificado.

azureConnectionName	string Nome da conexão que identifica a conexão de endpoint privada do Azure.
azureLinkId	string ID do link que identifica a conexão de endpoint privado do Azure.
comment	string String legível para humanos para associar a esse endpoint privado.
customerEndpointDNSName	string Etiqueta legível por humanos para identificar o nome DNS do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para a região.
customerEndpointIPAddress	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Endereço IP usado para se conectar ao endpoint privado do Azure.
endpointId necessário	string = 22 caracteres ^vpce-[0-9a-f]{17}$ String única alfanumérica de 24 caracteres que identifica o endpoint privado. O Atlas Data Lake é compatível com endpoints privados da Amazon Web Services que utilizam a funcionalidade AWS PrivateLink.
Mensagem de erro	string Mensagem de erro descrevendo uma falha aprovando a solicitação de endpoint privado.
fornecedor	string Padrão: "AWS" Valor: "AWS" Etiqueta legível por humanos que identifica o provedor de serviços de nuvem. O Atlas Data Lake suporta apenas Amazon Web Services.
região	string Etiqueta legível por humanos para identificar a região do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para customerEndpointDNSName.
Status	string Enum: "PENDENTE" "OK" "FAILED" "DELETING" Status da solicitação de conexão do endpoint privado.
type	string Padrão: "DATA_LAKE" Valor: "DATA_LAKE" Etiqueta legível para humanos que identifica o tipo de recurso associado a este endpoint privado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"azureConnectionName": "string",
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}

Exemplos de resposta

201
400
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"azureConnectionName": "string",
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 0
}

Remover uma Instância do banco de dados federado e um endpoint privado do Online Archive de um projeto

Remove um endpoint privado para instâncias do banco de dados federados e arquivos online no projeto especificado. Para usar esse recurso, a chave de API solicitada deve ter a role de Proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

endpointId

necessário

string = 22 caracteres ^vpce-[0-9a-f]{17}$

String única alfanumérica de 22 caracteres que identifica o endpoint privado a ser removido. O Atlas Data Federation é compatível com endpoints privados da Amazon Web Services que utilizam a funcionalidade AWS PrivateLink.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retorne uma Instância de banco de dados federado e um Endpoint privado do Online Archive em um projeto

Retorna o endpoint privado especificado para instâncias do banco de dados federado ou Online Archives no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter as roles de somente leitura do projeto ou administrador de gráficos do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

endpointId

necessário

string = 22 caracteres ^vpce-[0-9a-f]{17}$

String única alfanumérica de 24 caracteres que identifica o endpoint privado a ser retornado. O Atlas Data Federation é compatível com endpoints privados da Amazon Web Services que utilizam a funcionalidade AWS PrivateLink.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"azureConnectionName": "string",
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}

Pipelines do Data Lake

Retorna, edita e remove Atlas Data Lake Pipelines e execuções associadas.

Os pipelines do Data Lake estão obsoletos. Consulte o Guia de descontinuação do Data Lake.

Retornar todos os pipelines do Data Lake de um projeto Obsoleto

Retorna uma lista de pipelines do data lake. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

[{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}
]

Criar um pipeline do Data Lake Obsoleto

Cria um pipeline de data lake.

Os pipelines do Data Lake estão obsoletos. Consulte o Guia de descontinuação do Data Lake.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Cria um pipeline de data lake.

	objeto (Política de retenção do conjunto de dados) Política de retenção de Data Lake para um pipeline de Data Lake programado.
name	string Nome deste Data Lake Pipeline.
	objeto (Destino da ingestão) Destino da ingestão de um pipeline de data lake.
	objeto (Fonte da ingestão) Fonte da ingestão de um Data Lake Pipeline.
	Array de objetos (Transformação de campo) Campos a serem excluídos para este pipeline de data lake.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"datasetRetentionPolicy": {"units": "DAYS",
"value": 1
},
"name": "string",
"sink": { },
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string"
},
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Remover um pipeline do Data Lake Obsoleto

Remove um pipeline do Data Lake.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um pipeline do Data Lake Obsoleto

Retorna os detalhes de um Data Lake Pipeline dentro do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Atualizar um pipeline do data lake Obsoleto

Atualiza um Data Lake Pipeline.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Atualiza um Data Lake Pipeline.

	objeto (Política de retenção do conjunto de dados) Política de retenção de Data Lake para um pipeline de Data Lake programado.
name	string Nome deste Data Lake Pipeline.
	objeto (Destino da ingestão) Destino da ingestão de um pipeline de data lake.
	objeto (Fonte da ingestão) Fonte da ingestão de um Data Lake Pipeline.
	Array de objetos (Transformação de campo) Campos a serem excluídos para este pipeline de data lake.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"datasetRetentionPolicy": {"units": "DAYS",
"value": 1
},
"name": "string",
"sink": { },
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string"
},
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Retornar os agendamentos de ingestão disponíveis para um pipeline de Data Lake Preterido

Retorna uma lista de itens de política de agendamento de backup que você pode usar como fonte do pipeline do Data Lake. Para usar este recurso, a chave da API solicitante deve possuir a função de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

[{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "stringstringstringstring",
"retentionUnit": "days",
"retentionValue": 0
}
]

Retornar snapshots de backup disponíveis para um pipeline de data lake Obsoleto

Retorna uma lista de snapshots de backup que você pode usar para acionar uma execução de pipeline on-demand. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
completedAfter	string <date-time> Exemplo: completedAfter=2022-01-01T00:00:00Z Data e hora após as quais o MongoDB Cloud criou o snapshot. Se especificado, o MongoDB Cloud retorna snapshots de backup disponíveis criados somente após essa data e hora. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}
],
"totalCount": 0
}

Pausar um pipeline de data lake Obsoleto

Pausa a ingestão de um Data Lake Pipeline no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Retomar um pipeline do Data Lake Obsoleto

Retoma a ingestão de um Data Lake Pipeline no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS",
"clusterName": "string",
"collectionName": "string",
"databaseName": "string",
"groupId": "32b6e34b3d91647abb20e7b8"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

Retornar todas as execuções de um pipeline do Data Lake de um projeto Obsoleto

Retorna uma lista das execuções anteriores do Data Lake Pipeline. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
createdBefore	string <date-time> Exemplo: createdBefore=2022-01-01T00:00:00Z Se especificado, o Atlas retornará somente as execuções de pipeline data lake iniciadas antes dessa hora e data.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"_id": "32b6e34b3d91647abb20e7b8",
"backupFrequencyType": "HOURLY",
"createdDate": "2019-08-24T14:15:22Z",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"phase": "SNAPSHOT",
"pipelineId": "32b6e34b3d91647abb20e7b8",
"scheduledDeletionDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "PENDING",
"stats": {"bytesExported": 0,
"numDocs": 0
}
}
],
"totalCount": 0
}

Excluir conjunto de dados de execução de pipeline Obsoleto

Exclui o conjunto de dados gerado pelo Atlas durante a execução do pipeline especificado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
pipelineName necessário	string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline.
pipelineRunId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 caracteres hexadecimais que identifica uma execução do pipeline de data lake.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

202
400
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma execução da pipeline do Data Lake Obsoleto

Retorna os detalhes de um Data Lake Pipeline executado dentro do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
pipelineName necessário	string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline.
pipelineRunId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 caracteres hexadecimais que identifica uma execução do pipeline de data lake.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"backupFrequencyType": "HOURLY",
"createdDate": "2019-08-24T14:15:22Z",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"phase": "SNAPSHOT",
"pipelineId": "32b6e34b3d91647abb20e7b8",
"scheduledDeletionDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "PENDING",
"stats": {"bytesExported": 0,
"numDocs": 0
}
}

Acionar a ingestão de snapshots sob demanda Obsoleto

Aciona uma ingestão do Data Lake Pipeline de um snapshot especificado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

pipelineName

necessário

string [ 1 ... 64 ] caracteres ^[^/\\ "$]{1,64}$

Etiqueta legível para humanos que identifica o Data Lake Pipeline.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Aciona uma única execução de ingestão de um snapshot.

	objeto (Política de retenção do conjunto de dados) Política de retenção de Data Lake para um pipeline de Data Lake programado.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"datasetRetentionPolicy": {"units": "DAYS",
"value": 1
},
"snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"backupFrequencyType": "HOURLY",
"createdDate": "2019-08-24T14:15:22Z",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"phase": "SNAPSHOT",
"pipelineId": "32b6e34b3d91647abb20e7b8",
"scheduledDeletionDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "PENDING",
"stats": {"bytesExported": 0,
"numDocs": 0
}
}

Utilizadores de banco de dados

Retorna, adiciona, edita e remove usuários do banco de dados.

Retornar todos os usuários de banco de dados de um projeto

Retorna todos os usuários de banco de dados que pertencem ao projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [{"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [{"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}
],
"totalCount": 0
}

Criar um utilizador de banco de dados em um projeto

Cria um usuário do banco de dados no projeto especificado. O MongoDB Cloud permite um máximo de 100 usuários de banco de dados por projeto. Se precisar de mais de 100 usuários de banco de dados em um projeto, entre em contato com o Suporte. Para usar esse recurso, a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de gráficos do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria um usuário do banco de dados no projeto especificado.

awsIAMType

string

Padrão: "NONE"

Enum: "NONE" "USUÁRIO" "ROLE"

Rótulo legível por humanos que indica se o novo usuário do banco de dados se autentica com as credenciais do Amazon Web Services (AWS) Identity and Access Management (IAM) associadas ao usuário ou à função do usuário.

Nome do Banco de Dados

necessário

string

Padrão: "admin"

Enum: "admin" "$external"

O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

deleteAfterDate

string <date-time>

Data e hora em que o MongoDB Cloud exclui o usuário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC e pode incluir a designação de zona. Você deve especificar uma data futura que caia dentro de uma semana após fazer a solicitação de Interface de Programação de Aplicativo (API).

Descrição

string <= 100 caracteres

Descrição deste usuário de banco de dados.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica o projeto.

Array de objetos (Etiqueta do componente)

Lista que contém os pares de valores-chave para marcar e categorizar o usuário do banco de dados MongoDB. Os rótulos que você define não aparecem no console.

ldapAuthType

string

Padrão: "NONE"

Enum: "NONE" "GROUP" "USUÁRIO"

Parte do registro do Lightweight Directory Access Protocol (LDAP) que o banco de dados usa para autenticar esse usuário do banco de dados no host LDAP.

oidcAuthType

string

Padrão: "NONE"

Enum: "NONE" "IDP_GROUP" "USUÁRIO"

Rótulo legível por humanos que indica se o novo usuário de banco de dados ou grupo se autentica com a autenticação federada OIDC. Para criar um usuário de autenticação federado, especifique o valor de USER neste campo. Para criar um grupo de autenticação federado, especifique o valor de IDP_GROUP neste campo.

Senha

string >= 8 caracteres

String alfanumérica que autentica este usuário de banco de dados no banco de dados especificado no databaseName. Para autenticar com SCRAM-SHA, você deve especificar este parâmetro. Este parâmetro não aparece nesta resposta.

SCRAM-SHA

Array de objetos (Role de usuário de banco de dados)

Lista que fornece os pares de um papel com um banco de dados aplicável.

Array de objetos (Escopo do usuário do banco de dados)

Lista que contém clusters, data lakes do MongoDB Atlas e instâncias de stream do MongoDB Atlas que esse usuário de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao usuário do banco de dados acesso a todos os clusters, todos os data lakes do MongoDB Atlas e todas as instâncias de stream do MongoDB Atlas no projeto.

nome de usuário

necessário

string <= 1024 caracteres

Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação	Parâmetro necessário	Valor do parâmetro	formato de nome de usuário
AWS IAM	awsIAMType	FUNÇÃO	ARN
AWS IAM	awsIAMType	USUÁRIO	ARN
x.509	x509Type	CLIENTE	Nome distintivo RFC 2253
x.509	x509Type	GERENCIADO	Nome distintivo RFC 2253
LDAP	ldapAuthType	USUÁRIO	Nome distintivo RFC 2253
LDAP	ldapAuthType	GRUPO	Nome distintivo RFC 2253
OIDC Workforce	oidcAuthType	IDP_GROUP	ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
Carga de trabalho do OIDC	oidcAuthType	USUÁRIO	O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
SCRAM-SHA	awsIAMType, x509Type, ldapAuthType, oidcAuthType	none	Texto alfanumérico

x509Type

string

Padrão: "NONE"

Enum: "NONE" "CUSTOMER" "MANAGED"

Método X.509 que o MongoDB Cloud usa para autenticar o usuário de banco de dados.

Para X.509 gerenciado pelo aplicativo, especifique MANAGED.
Para X.509 autogerenciado, especifique CUSTOMER.

Os usuários criados com o método CUSTOMER exigem um Nome Comum (CN) no parâmetro username. Você deve criar usuários autenticados externamente no banco de dados do $external.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS Autenticação do IAM

{"awsIAMType": "USER",
"databaseName": "$external",
"groupId": "32b6e34b3d91647abb20e7b8",
"roles": [{"databaseName": "sales",
"roleName": "readWrite"
},
{"databaseName": "marketing",
"roleName": "read"
}
],
"scopes": [{"name": "myCluster",
"type": "CLUSTER"
}
],
"username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [{"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [{"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}

Remover um utilizador de banco de dados de um projeto

Remove um usuário do banco de dados do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

Nome do Banco de Dados

necessário

string

O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

nome de usuário

necessário

string

Exemplo: SCRAM-SHA: dylan ou AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs ou x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Exemplo,DC=COM ou OIDC: IdPIdentifier/IdPGroupName

Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação	Parâmetro necessário	Valor do parâmetro	formato de nome de usuário
AWS IAM	awsIAMType	FUNÇÃO	ARN
AWS IAM	awsIAMType	USUÁRIO	ARN
x.509	x509Type	CLIENTE	Nome distintivo RFC 2253
x.509	x509Type	GERENCIADO	Nome distintivo RFC 2253
LDAP	ldapAuthType	USUÁRIO	Nome distintivo RFC 2253
LDAP	ldapAuthType	GRUPO	Nome distintivo RFC 2253
OIDC Workforce	oidcAuthType	IDP_GROUP	ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
Carga de trabalho do OIDC	oidcAuthType	USUÁRIO	O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
SCRAM-SHA	awsIAMType, x509Type, ldapAuthType, oidcAuthType	none	Texto alfanumérico

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
401
403
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um usuário de banco de dados de um projeto

Retorna um utilizador de banco de dados que pertence ao projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a role de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

Nome do Banco de Dados

necessário

string

O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

nome de usuário

necessário

string

Exemplo: SCRAM-SHA: dylan ou AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs ou x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Exemplo,DC=COM ou OIDC: IdPIdentifier/IdPGroupName

Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação	Parâmetro necessário	Valor do parâmetro	formato de nome de usuário
AWS IAM	awsIAMType	FUNÇÃO	ARN
AWS IAM	awsIAMType	USUÁRIO	ARN
x.509	x509Type	CLIENTE	Nome distintivo RFC 2253
x.509	x509Type	GERENCIADO	Nome distintivo RFC 2253
LDAP	ldapAuthType	USUÁRIO	Nome distintivo RFC 2253
LDAP	ldapAuthType	GRUPO	Nome distintivo RFC 2253
OIDC Workforce	oidcAuthType	IDP_GROUP	ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
Carga de trabalho do OIDC	oidcAuthType	USUÁRIO	O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
SCRAM-SHA	awsIAMType, x509Type, ldapAuthType, oidcAuthType	none	Texto alfanumérico

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [{"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [{"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}

Atualizar um utilizador de banco de dados em um projeto

Atualiza um utilizador de banco de dados que pertence ao projeto especificado. Para usar esse recurso, a chave API solicitante deve ter as roles de Proprietário do projeto ou Administrador de gráficos do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

Nome do Banco de Dados

necessário

string

O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

nome de usuário

necessário

string

Exemplo: SCRAM-SHA: dylan ou AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs ou x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Exemplo,DC=COM ou OIDC: IdPIdentifier/IdPGroupName

Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação	Parâmetro necessário	Valor do parâmetro	formato de nome de usuário
AWS IAM	awsIAMType	FUNÇÃO	ARN
AWS IAM	awsIAMType	USUÁRIO	ARN
x.509	x509Type	CLIENTE	Nome distintivo RFC 2253
x.509	x509Type	GERENCIADO	Nome distintivo RFC 2253
LDAP	ldapAuthType	USUÁRIO	Nome distintivo RFC 2253
LDAP	ldapAuthType	GRUPO	Nome distintivo RFC 2253
OIDC Workforce	oidcAuthType	IDP_GROUP	ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
Carga de trabalho do OIDC	oidcAuthType	USUÁRIO	O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
SCRAM-SHA	awsIAMType, x509Type, ldapAuthType, oidcAuthType	none	Texto alfanumérico

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza um usuário de banco de dados que pertence ao projeto especificado.

awsIAMType

string

Padrão: "NONE"

Enum: "NONE" "USUÁRIO" "ROLE"

Rótulo legível por humanos que indica se o novo usuário do banco de dados se autentica com as credenciais do Amazon Web Services (AWS) Identity and Access Management (IAM) associadas ao usuário ou à função do usuário.

Nome do Banco de Dados

necessário

string

Padrão: "admin"

Enum: "admin" "$external"

O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

deleteAfterDate

string <date-time>

Data e hora em que o MongoDB Cloud exclui o usuário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC e pode incluir a designação de zona. Você deve especificar uma data futura que caia dentro de uma semana após fazer a solicitação de Interface de Programação de Aplicativo (API).

Descrição

string <= 100 caracteres

Descrição deste usuário de banco de dados.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica o projeto.

Array de objetos (Etiqueta do componente)

Lista que contém os pares de valores-chave para marcar e categorizar o usuário do banco de dados MongoDB. Os rótulos que você define não aparecem no console.

ldapAuthType

string

Padrão: "NONE"

Enum: "NONE" "GROUP" "USUÁRIO"

Parte do registro do Lightweight Directory Access Protocol (LDAP) que o banco de dados usa para autenticar esse usuário do banco de dados no host LDAP.

oidcAuthType

string

Padrão: "NONE"

Enum: "NONE" "IDP_GROUP" "USUÁRIO"

Rótulo legível por humanos que indica se o novo usuário de banco de dados ou grupo se autentica com a autenticação federada OIDC. Para criar um usuário de autenticação federado, especifique o valor de USER neste campo. Para criar um grupo de autenticação federado, especifique o valor de IDP_GROUP neste campo.

Senha

string >= 8 caracteres

String alfanumérica que autentica este usuário de banco de dados no banco de dados especificado no databaseName. Para autenticar com SCRAM-SHA, você deve especificar este parâmetro. Este parâmetro não aparece nesta resposta.

SCRAM-SHA

Array de objetos (Role de usuário de banco de dados)

Lista que fornece os pares de um papel com um banco de dados aplicável.

Array de objetos (Escopo do usuário do banco de dados)

Lista que contém clusters, data lakes do MongoDB Atlas e instâncias de stream do MongoDB Atlas que esse usuário de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao usuário do banco de dados acesso a todos os clusters, todos os data lakes do MongoDB Atlas e todas as instâncias de stream do MongoDB Atlas no projeto.

nome de usuário

necessário

string <= 1024 caracteres

Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

Método de autenticação	Parâmetro necessário	Valor do parâmetro	formato de nome de usuário
AWS IAM	awsIAMType	FUNÇÃO	ARN
AWS IAM	awsIAMType	USUÁRIO	ARN
x.509	x509Type	CLIENTE	Nome distintivo RFC 2253
x.509	x509Type	GERENCIADO	Nome distintivo RFC 2253
LDAP	ldapAuthType	USUÁRIO	Nome distintivo RFC 2253
LDAP	ldapAuthType	GRUPO	Nome distintivo RFC 2253
OIDC Workforce	oidcAuthType	IDP_GROUP	ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
Carga de trabalho do OIDC	oidcAuthType	USUÁRIO	O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
SCRAM-SHA	awsIAMType, x509Type, ldapAuthType, oidcAuthType	none	Texto alfanumérico

x509Type

string

Padrão: "NONE"

Enum: "NONE" "CUSTOMER" "MANAGED"

Método X.509 que o MongoDB Cloud usa para autenticar o usuário de banco de dados.

Para X.509 gerenciado pelo aplicativo, especifique MANAGED.
Para X.509 autogerenciado, especifique CUSTOMER.

Os usuários criados com o método CUSTOMER exigem um Nome Comum (CN) no parâmetro username. Você deve criar usuários autenticados externamente no banco de dados do $external.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"description": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"oidcAuthType": "NONE",
"password": "stringst",
"roles": [{"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [{"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"description": "string",
"labels": [{"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [{"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [{"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}

Criptografia em repouso usando o gerenciamento de chaves de cliente

Retorna e edita a Encryption at Rest usando a configuração de gerenciamento de chaves de cliente. O MongoDB Cloud criptografa todo o armazenamento, independente de você usar ou não seu próprio gerenciamento de chaves.

Retornar uma configuração para Encryption at Rest usando chaves personalizadas gerenciadas pelo cliente para um projeto

Retorna a configuração da Encryption at Rest usando as chaves que você gerencia por meio do fornecedor de nuvem. O MongoDB Cloud criptografa todo o armazenamento, mesmo que você não use seu próprio gerenciamento de chaves. Esse recurso exige que a chave de API solicitante tenha a role de proprietário do projeto.

LIMITADO A M10 OU SUPERIOR: o MongoDB Cloud limita esse recurso às camadas de clusters dedicados M10 ou superior.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"awsKms": {"accessKeyID": "019dd98d94b4bb778e7552e4",
"customerMasterKeyID": "string",
"enabled": true,
"region": "US_GOV_WEST_1",
"valid": true
},
"azureKeyVault": {"azureEnvironment": "AZURE",
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055",
"enabled": true,
"keyIdentifier": "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
"keyVaultName": "string",
"requirePrivateNetworking": true,
"resourceGroupName": "string",
"subscriptionID": "d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
"tenantID": "f95ac700-4c8f-4a38-a8d1-1582733edd5b",
"valid": true
},
"googleCloudKms": {"enabled": true,
"keyVersionResourceID": "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
"valid": true
}
}

Atualizar a configuração para Encryption at Rest usando chaves personalizadas gerenciadas pelo cliente para um projeto

Atualiza a configuração da criptografia em repouso usando as chaves que você gerencia por meio do seu fornecedor de nuvem. O MongoDB Cloud criptografa todo o armazenamento, mesmo que você não use seu próprio gerenciamento de chaves. Este recurso exige que a chave de API solicitante tenha a função de "proprietário do projeto". Este recurso não está disponível para clusters gratuitos M0, M2, M5 ou clusters sem servidor.

Depois que você configurar pelo menos uma Criptografia em Repouso usando um provedor de Gerenciamento de Chaves do Cliente para o projeto do MongoDB Cloud, os Proprietários do Projeto poderão ativar a Criptografia em Repouso usando o Gerenciamento de Chaves do Cliente para cada cluster do MongoDB Cloud para o qual eles exigem criptografia. O provedor de criptografia em repouso usando o gerenciamento de chaves do cliente não precisa corresponder ao provedor de serviços de nuvem do cluster. O MongoDB Cloud não gira automaticamente as chaves de criptografia gerenciadas pelo usuário. Adote a criptografia em repouso de sua preferência usando a documentação e a orientação do provedor de gerenciamento de chaves do cliente para obter as práticas recomendadas de rotação de chaves. O MongoDB Cloud cria automaticamente um alerta de rotação de chaves de 90 dias quando você configura a criptografia em repouso usando o gerenciamento de chaves do cliente usando seu gerenciamento de chaves em um projeto do MongoDB Cloud. O MongoDB Cloud criptografa todo o armazenamento, independentemente de você usar ou não seu próprio gerenciamento de chaves.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Os parâmetros exigidos dependem se alguém habilitou a Encryption at Rest usando o gerenciamento de chaves de cliente:

Se você tiver habilitado a criptografia em repouso usando o Customer Key Management (CMK), o Atlas exigirá todos os parâmetros do fornecedor de criptografia desejado.

Para usar o AWS Key Management Service (KMS), o MongoDB Cloud exige todos os campos no objeto awsKms.
Para usar o Azure Key Vault, o MongoDB Cloud exige todos os campos no objeto azureKeyVault.
Para usar o serviço de gerenciamento de chaves (KMS) do Google Cloud, o MongoDB Cloud requer todos os campos do objeto googleCloudKms.

Se você habilitou a criptografia em repouso usando o Gerenciamento de Chaves do Cliente, os administradores poderão passar apenas os campos alterados para o objeto awsKms, azureKeyVault ou googleCloudKms para atualizar a configuração para esse endpoint.

	objeto (AWSKMSConfiguration) Detalhes de configuração KMS da Amazon Web Services (AWS) e conjunto de configurações de criptografia em repouso para o projeto especificado. Serviço de gerenciamento de chaves de serviços web da Amazon
	objeto (AzureKeyVault) Detalhes que definem a configuração da Encryption at Rest usando o Azure Key Vault (AKV). Azure Key Vault
	objeto (GoogleCloudKMS) Detalhes que definem a configuração da criptografia em repouso usando o Google Cloud Key Management Service (KMS). Serviço de gerenciamento de chaves do Google Cloud

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"awsKms": {"accessKeyID": "019dd98d94b4bb778e7552e4",
"customerMasterKeyID": "string",
"enabled": true,
"region": "US_GOV_WEST_1",
"roleId": "32b6e34b3d91647abb20e7b8",
"secretAccessKey": "string"
},
"azureKeyVault": {"azureEnvironment": "AZURE",
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055",
"enabled": true,
"keyIdentifier": "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
"keyVaultName": "string",
"requirePrivateNetworking": true,
"resourceGroupName": "string",
"secret": "string",
"subscriptionID": "d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
"tenantID": "f95ac700-4c8f-4a38-a8d1-1582733edd5b"
},
"googleCloudKms": {"enabled": true,
"keyVersionResourceID": "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
"serviceAccountKey": "string"
}
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"awsKms": {"accessKeyID": "019dd98d94b4bb778e7552e4",
"customerMasterKeyID": "string",
"enabled": true,
"region": "US_GOV_WEST_1",
"valid": true
},
"azureKeyVault": {"azureEnvironment": "AZURE",
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055",
"enabled": true,
"keyIdentifier": "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
"keyVaultName": "string",
"requirePrivateNetworking": true,
"resourceGroupName": "string",
"subscriptionID": "d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
"tenantID": "f95ac700-4c8f-4a38-a8d1-1582733edd5b",
"valid": true
},
"googleCloudKms": {"enabled": true,
"keyVersionResourceID": "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
"valid": true
}
}

Eventos

Retorna eventos. Esta collection permanece sob revisão e pode mudar.

Retornar todos os eventos de um projeto

Retorna um evento para o projeto especificado. Os eventos identificam atividades significativas de banco de dados, faturamento ou segurança, ou alterações de status. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
clusterNames	Array de strings[ items [ 1 .. 64 ] characters ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ ] Etiqueta legível por humanos que identifica o cluster.
	Array de Tipos de auditoria de alerta (objeto) ou Tipos de auditoria de alerta (objeto) ou Tipos de evento de usuário de API (objeto) ou Tipos de evento de conta de serviço (objeto) ou Tipos de evento de Atlas App Services (objeto) ou tipos de evento de indexação automática (objeto) ou tipos de evento de configuração de automação (objeto) ou tipos de auditoria de VPC de mesmo nível da AWS (objeto) ou tipos de auditoria de pareamento de rede do Azure (objeto) ou tipos de evento de cobrança (objeto) ou tipos de auditoria de conexão de cluster (objeto) ou tipos de eventos de cluster (objeto) ou tipos de eventos de backup do Cps (objeto) ou Tipos de Eventos Acessados pelo Data Explorer (objeto) ou Tipos de Eventos de Política de Conformidade de Backup do CPS (objeto) ou Tipos de Eventos de Backup em Disco (objeto) ou Tipos de Eventos de Criptografia (objeto) ou Tipos de Auditoria de Bucket de Exportação (objeto) ou Tipos de Auditoria de Índice FTS (objeto) ou Tipos de Auditoria de pareamento de VPC do GCP (objeto) ou Tipos de Auditoria de Grupo (objeto) ou Tipos de Eventos de Grupo (objeto) ou Tipos de Eventos de Integração de Grupo (objeto) ou Tipos de Eventos de Host (objeto) ou Tipos de Eventos de Métrica de Host (objeto) ou Compilação de Índice Tipos de auditoria (objeto) ou Tipos de auditoria NDS (objeto) ou NDS Tipos de auditoria de verificação de banco de dados (objeto) ou Tipos de auditoria de validação de dados NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria do período de manutenção NDS (objeto) ou Tipos de auditoria de instância sem servidor NDS (objeto) ou Tipos de auditoria de dimensionamento automático sem servidor NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria de implantação de serviço de ponto de extremidade de locatário NDS (objeto) ou Autenticação de usuário NDS x509 Tipos de Evento (objeto) ou Tipos de Evento de Atlas Online Archive (objeto) ou Tipos de Auditoria de Link Privado (objeto) ou Tipos de Evento de Operação Proativa (objeto) ou Tipos de Evento ReplicaSet (objeto) ou Tipos de Auditoria de Implantação de Pesquisa (objeto) ou Tipos de Auditoria de Implantação sem Servidor (objeto) ou Tipos de Evento sem Servidor (objeto) ou Configurar Tipos de Auditoria sem Servidor (objeto) ou Tipos de Evento de Fluxos (objeto) ou Tipos de Evento do Processador de Fluxo (objeto) ou Tipos de Evento de Caso de Suporte (objeto) ou Tipos de Evento de Suporte (objeto) ou Tipos de Evento de equipe (objeto) ou Tipos de Evento de Backup de Locatário (objeto) ou Tipos de Evento de Usuário (objeto) ou Tipos de Auditoria de Versão (objeto) ou Tipos de Evento de Recurso (objeto) (EventTypeForNdsGroup) Categoria de incidente registrada neste ponto temporal. IMPORTANTE: a lista completa de valores do tipo de evento muda com frequência.
	Array de Tipos de auditoria de alerta (objeto) ou Tipos de auditoria de alerta (objeto) ou Tipos de evento de usuário de API (objeto) ou Tipos de evento de conta de serviço (objeto) ou Tipos de evento de Atlas App Services (objeto) ou tipos de evento de indexação automática (objeto) ou tipos de evento de configuração de automação (objeto) ou tipos de auditoria de VPC de mesmo nível da AWS (objeto) ou tipos de auditoria de pareamento de rede do Azure (objeto) ou tipos de evento de cobrança (objeto) ou tipos de auditoria de conexão de cluster (objeto) ou tipos de eventos de cluster (objeto) ou tipos de eventos de backup do Cps (objeto) ou Tipos de Eventos Acessados pelo Data Explorer (objeto) ou Tipos de Eventos de Política de Conformidade de Backup do CPS (objeto) ou Tipos de Eventos de Backup em Disco (objeto) ou Tipos de Eventos de Criptografia (objeto) ou Tipos de Auditoria de Bucket de Exportação (objeto) ou Tipos de Auditoria de Índice FTS (objeto) ou Tipos de Auditoria de pareamento de VPC do GCP (objeto) ou Tipos de Auditoria de Grupo (objeto) ou Tipos de Eventos de Grupo (objeto) ou Tipos de Eventos de Integração de Grupo (objeto) ou Tipos de Eventos de Host (objeto) ou Tipos de Eventos de Métrica de Host (objeto) ou Compilação de Índice Tipos de auditoria (objeto) ou Tipos de auditoria NDS (objeto) ou NDS Tipos de auditoria de verificação de banco de dados (objeto) ou Tipos de auditoria de validação de dados NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria do período de manutenção NDS (objeto) ou Tipos de auditoria de instância sem servidor NDS (objeto) ou Tipos de auditoria de dimensionamento automático sem servidor NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria de dimensionamento automático NDS (objeto) ou Tipos de auditoria de implantação de serviço de ponto de extremidade de locatário NDS (objeto) ou Autenticação de usuário NDS x509 Tipos de Evento (objeto) ou Tipos de Evento de Atlas Online Archive (objeto) ou Tipos de Auditoria de Link Privado (objeto) ou Tipos de Evento de Operação Proativa (objeto) ou Tipos de Evento ReplicaSet (objeto) ou Tipos de Auditoria de Implantação de Pesquisa (objeto) ou Tipos de Auditoria de Implantação sem Servidor (objeto) ou Tipos de Evento sem Servidor (objeto) ou Configurar Tipos de Auditoria sem Servidor (objeto) ou Tipos de Evento de Fluxos (objeto) ou Tipos de Evento do Processador de Fluxo (objeto) ou Tipos de Evento de Caso de Suporte (objeto) ou Tipos de Evento de Suporte (objeto) ou Tipos de Evento de equipe (objeto) ou Tipos de Evento de Backup de Locatário (objeto) ou Tipos de Evento de Usuário (objeto) ou Tipos de Auditoria de Versão (objeto) ou Tipos de Evento de Recurso (objeto) (EventTypeForNdsGroup) Categoria do evento que você gostaria de excluir dos resultados da query, como CLUSTER_CREATED IMPORTANTE: os nomes dos tipos de eventos mudam frequentemente. Verifique se você especifica o tipo de evento corretamente conferindo a lista completa de tipos de evento.
includeRaw	booleano Padrão: false Sinalizador que indica se o documento bruto deve ser incluído na saída. O documento bruto contém metainformações adicionais sobre o evento.
maxDate	string <date-time> Data e hora a partir de quando o MongoDB Cloud para de retornar eventos. Este parâmetro utiliza o formato de registro de data/hora ISO 8601 em UTC.
minDate	string <date-time> Data e hora de quando o MongoDB Cloud começa a retornar eventos. Este parâmetro utiliza o formato de registro de data/hora ISO 8601 em UTC.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "AUTO_INDEXING_ENABLED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": false,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "test.user@mongodb.com",
"raw": {"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2019-08-24T14:15:22Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "test.user@mongodb.com"
}
],
"totalCount": 0
}

Retornar um evento de um projeto

Retorna um evento para o projeto especificado. Os eventos identificam atividades significativas de banco de dados, faturamento ou segurança, ou alterações de status. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

eventId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica o evento que você deseja retornar. Use o endpoint /events para recuperar todos os eventos aos quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
includeRaw	booleano Padrão: false Sinalizador que indica se o documento bruto deve ser incluído na saída. O documento bruto contém metainformações adicionais sobre o evento.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outro evento

{"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "AUTO_INDEXING_ENABLED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": false,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "test.user@mongodb.com",
"raw": {"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2019-08-24T14:15:22Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "test.user@mongodb.com"
}

Retornar todos os eventos de uma organização

Retorna todos os eventos da organização especificada. Os eventos identificam atividades significativas de banco de dados, de faturamento ou de segurança ou mudanças de status. Para usar este recurso, a chave de API solicitante deve ter a função de "membro da organização".

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
	Array de Tipos de auditoria de alerta (objeto) ou Tipos de auditoria de alerta (objeto) ou Tipos de evento de usuário de API (objeto) ou Tipos de evento de conta de serviço (objeto) ou Tipos de evento de faturamento (objeto) ou Tipos de evento de configurações de federação (objeto) ou Tipos de auditoria de grupo (objeto) ou Tipos de auditoria de migração Mlab (objeto) ou Tipos de auditoria de migração Mlab (objeto) ou Tipos de auditoria NDS (objeto) ou Tipos de evento de organização (objeto) ou Tipos de evento de parceiros (objeto) ou Tipos de evento de suporte (objeto) ou Tipos de evento de equipe (objeto) ou Tipos de evento de usuário (objeto) ou Tipos de evento de recurso (objeto) ou Tipos de auditoria de política de recursos do Atlas (objeto) (EventTypeForOrg) Categoria de incidente registrada neste ponto temporal. IMPORTANTE: a lista completa de valores do tipo de evento muda com frequência.
includeRaw	booleano Padrão: false Sinalizador que indica se o documento bruto deve ser incluído na saída. O documento bruto contém metainformações adicionais sobre o evento.
maxDate	string <date-time> Data e hora a partir de quando o MongoDB Cloud para de retornar eventos. Este parâmetro utiliza o formato de registro de data/hora ISO 8601 em UTC.
minDate	string <date-time> Exemplo: minDate=2021-11-17T23:15:00.06Z Data e hora de quando o MongoDB Cloud começa a retornar eventos. Este parâmetro utiliza o formato de registro de data/hora ISO 8601 em UTC.

Respostas

Exemplos de resposta

200
400
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "FEDERATION_SETTINGS_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": false,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "test.user@mongodb.com",
"raw": {"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2019-08-24T14:15:22Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "test.user@mongodb.com"
}
],
"totalCount": 0
}

Retornar um evento de uma organização

Retorna um evento para a organização especificada. Os eventos identificam atividades significativas de banco de dados, faturamento ou segurança, ou alterações de status. Para usar esse recurso, a chave de API solicitante deve ter a role de nó da organização.

Este recurso permanece sob revisão e pode mudar.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
eventId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o evento que você deseja retornar. Use o endpoint /events para recuperar todos os eventos aos quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
includeRaw	booleano Padrão: false Sinalizador que indica se o documento bruto deve ser incluído na saída. O documento bruto contém metainformações adicionais sobre o evento.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

Qualquer outro evento

{"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2019-08-24T14:15:22Z",
"eventTypeName": "FEDERATION_SETTINGS_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": false,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "test.user@mongodb.com",
"raw": {"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2019-08-24T14:15:22Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "test.user@mongodb.com"
}

Autenticação federada

Retorna, adiciona, edita e remove recursos relacionados à federação, como mapeamentos de funções e configurações de organizações conectadas.

Excluir uma instância de configurações de federação

Exclui a instância de configurações de federação e todos os dados associados, incluindo fornecedores de identidade e domínios. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização na última organização conectada restante. Aviso: as solicitações para esse recurso falharão se houver mais de uma organização conectada na federação.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 55fa922fb343282757d9554e

String exclusiva de 24 dígitos hexadecimais que identifica sua federação.

Respostas

Exemplos de resposta

400
401
404
500

Tipo de conteúdo

aplicação/json

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

Retornar todas as configurações da organização conectada de uma federação

Retorna todas as configurações de organização conectadas na federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" em uma das organizações conectadas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 55fa922fb343282757d9554e

String exclusiva de 24 dígitos hexadecimais que identifica sua federação.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "stringstringstringstring"
}
]
}
],
"totalCount": 0
}

Remover uma configuração de organização conectada a uma federação

Remove uma configuração da organização conectada da federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização. Aviso: essa solicitação falhará se somente uma organização conectada existir na federação.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 dígitos hexadecimais que identifica a configuração da organização conectada a ser removida.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma configuração organizacional conectada a uma federação

Retorna a configuração da organização conectada especificada da federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização na organização conectada.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24 dígitos hexadecimais que identifica a configuração da organização conectada que será retornada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "stringstringstringstring"
}
]
}

Atualizar uma configuração de organização conectada a uma federação

Atualiza uma configuração da organização conectada a partir da federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização.

Aviso: se a configuração da organização não tiver um fornecedor de identidade associado, você não poderá usar esse recurso para atualizar mapeamentos de role ou publicar concessões de role de autorização.

Observação: o campo domainRestrictionEnabled fica definido como "false" por padrão se não for fornecido na solicitação.

Observação: se o campo identityProviderId não for fornecido, você desconectará a organização e o provedor de identidade.

Aviso: os fornecedores de identidade de acesso a dados conectados no momento que não estão no campo dataAccessIdentityProviderIDs serão desconectados.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 dígitos hexadecimais que identifica a configuração da organização conectada que será atualizada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

A configuração da organização conectada que você deseja atualizar.

dataAccessIdentityProviderIds	Array de strings unique [ itens = 24 caracteres ^([a-f0-9]{24})$ ] A collection de IDs únicos que representam os fornecedores de identidade que podem ser usados para acesso a dados nessa organização.
domainAllowList	Array de strings unique Domínios aprovados que restringem os usuários que podem ingressar na organização com base em seus endereços de e-mail.
domainRestrictionEnabled necessário	booleano O valor que indica se a restrição de domínio está habilitada para esta organização conectada.
identityProviderId	string = 20 caracteres ^([a-f0-9]{20})$ String 20-hexadecimal legada que identifica o provedor de identidade de acesso à interface do usuário ao qual essa configuração da organização conectada está associada. Esse ID pode ser encontrado na guia Console de gerenciamento federado > aba Provedor de identidade, clicando no ícone de informações na linha IdP ID de um provedor de identidade configurado.
postAuthRoleGrants	Array de strings unique Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_BILLING_READ_ONLY" "ORG_READ_ONLY" Funções do Atlas que são concedidas a um usuário nessa organização após a autenticação. As funções são um rótulo legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a um usuário específico do MongoDB Cloud. Essas funções só podem ser funções específicas da organização.
	Array de objetos (Mapeamento de função de autenticação federada) unique Mapeamentos de role configurados nesta organização.
	Array de objetos (Usuário federado) Lista que contém os usuários com um endereço de e-mail que não corresponde a nenhum domínio na lista de permissões.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string"
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "stringstringstringstring"
}
]
}

Retornar todos os mapeamentos de roles de uma organização

Retorna todos os mapeamentos de função da organização especificada na federação especificada. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"totalCount": 0
}

Adicionar um mapeamento de role a uma organização

Adiciona um mapeamento de role na organização especificada na federação especificada. Para usar esse recurso, a chave API solicitada deve ter a role Proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

O mapeamento de role que você deseja criar.

externalGroupName necessário	string [ 1 ... 200 ] caracteres Rótulo legível único para humanos que identifica o grupo de fornecedores de identidade ao qual esse mapeamento de role se aplica.
	Array de objetos (RoleAssignment) unique Roles do Atlas e os identificadores exclusivos dos grupos e organizações associados a cada role. A array deve incluir pelo menos um elemento com uma função de organização e seu respectivo orgId. Cada elemento na array pode ter um valor para orgId ou groupId, mas não ambos.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"externalGroupName": "string",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}

Remover mapeamento de uma função de uma organização

Remove um mapeamento de role na organização especificada da federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
id necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 dígitos hexadecimais que identifica o mapeamento de função que você deseja remover.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

400
401
404
500

Tipo de conteúdo

aplicação/json

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

Retornar um mapeamento de role de uma organização

Retorna um mapeamento de função da organização especificada na federação especificada. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
id necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24 dígitos hexadecimais que identifica o mapeamento de função que você deseja retornar.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}

Atualizar mapeamento de uma função em uma organização

Atualiza um mapeamento de papel na organização especificada na federação especificada. Para usar esse recurso, a chave API solicitada deve ter a função Proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
id necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica o mapeamento de função que você deseja atualizar.
orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

O mapeamento de role que você deseja atualizar.

externalGroupName necessário	string [ 1 ... 200 ] caracteres Rótulo legível único para humanos que identifica o grupo de fornecedores de identidade ao qual esse mapeamento de role se aplica.
	Array de objetos (RoleAssignment) unique Roles do Atlas e os identificadores exclusivos dos grupos e organizações associados a cada role. A array deve incluir pelo menos um elemento com uma função de organização e seu respectivo orgId. Cada elemento na array pode ter um valor para orgId ou groupId, mas não ambos.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"externalGroupName": "string",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}

Retornar todos os provedores de identidade em uma federação

Retorna todos os fornecedores de identidade com o protocolo e tipo fornecido na federação especificada. Se nenhum protocolo for especificado, somente fornecedores de identidade SAML serão retornados. Se nenhum idpType for especificado, somente provedores de identidade WORKFORCE serão retornados. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização em uma das organizações conectadas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 55fa922fb343282757d9554e

String exclusiva de 24 dígitos hexadecimais que identifica sua federação.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
protocolo	Array de strings Itens Enum: "SAML" "OIDC" Os protocolos dos provedores de identidade de destino.
idpType	Array de strings Itens Enum: "WORKFORCE" "WORKLOAD" Os tipos dos provedores de identidade de destino.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"associatedOrgs": [{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "stringstringstringstring"
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"displayName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "stringstringstringst",
"protocol": "SAML",
"updatedAt": "2019-08-24T14:15:22Z",
"acsUrl": "string",
"associatedDomains": ["string"
],
"audienceUri": "string",
"pemFileInfo": {"certificates": [{"notAfter": "2019-08-24T14:15:22Z",
"notBefore": "2019-08-24T14:15:22Z"
}
],
"fileName": "string"
},
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "string",
"status": "ACTIVE"
}
],
"totalCount": 0
}

Retornar um fornecedor de identidade SAML

Retorna um fornecedor de identidade SAML da federação especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização em uma das organizações conectadas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
identityProviderId necessário	string = 20 caracteres ^([a-f0-9]{20})$ Exemplo: c2777a9eca931f29fc2f String legada com 20 dígitos hexadecimais que identifica o provedor de identidade. Essa ID pode ser encontrada na guia Console de Gerenciamento de Federação > Provedores de Identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"acsUrl": "string",
"associatedDomains": ["string"
],
"associatedOrgs": [{"dataAccessIdentityProviderIds": ["32b6e34b3d91647abb20e7b8"
],
"domainAllowList": ["string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "stringstringstringst",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": ["ORG_OWNER"
],
"roleMappings": [{"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [{"emailAddress": "user@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "stringstringstringstring"
}
]
}
],
"audienceUri": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"displayName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "stringstringstringst",
"pemFileInfo": {"certificates": [{"notAfter": "2019-08-24T14:15:22Z",
"notBefore": "2019-08-24T14:15:22Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "string",
"status": "ACTIVE",
"updatedAt": "2019-08-24T14:15:22Z"
}

Retornar os metadados de um provedor de identidade

Retorna os metadados de um provedor de identidade na federação especificada. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" em uma das organizações conectadas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

federationSettingsId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 55fa922fb343282757d9554e String exclusiva de 24 dígitos hexadecimais que identifica sua federação.
identityProviderId necessário	string = 20 caracteres ^([a-f0-9]{20})$ Exemplo: c2777a9eca931f29fc2f String legada com 20 dígitos hexadecimais que identifica o provedor de identidade. Essa ID pode ser encontrada na guia Console de Gerenciamento de Federação > Provedores de Identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

"string"

Retornar configurações de federação para uma organização

Retorna informações sobre as configurações de federação da organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização na organização conectada.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"federatedDomains": ["string"
],
"hasRoleMappings": true,
"id": "32b6e34b3d91647abb20e7b8",
"identityProviderId": "c2777a9eca931f29fc2f",
"identityProviderStatus": "ACTIVE"
}

Global Clusters

Retorna, adiciona e remove namespaces gerenciados pelo cluster global e mapeamentos de zona personalizada. Cada coleção em um cluster global está associada a um namespace gerenciado. Quando você cria um namespace gerenciado para um cluster global, o MongoDB Cloud cria uma coleção vazia para esse namespace. Criar um namespace gerenciado não preenche uma coleção com dados. Da mesma forma, excluir um namespace gerenciado não exclui a respectiva coleção. O MongoDB Cloud fragmenta a coleção vazia usando o campo de local necessário e uma chave de shard personalizada. Por exemplo, se sua chave de shard personalizada for city, a chave de shard composta será location, city. Cada cluster global também está associado a uma ou mais zonas de gravações globais. Quando um usuário cria um cluster global, o MongoDB Cloud mapeia automaticamente cada código de local para a zona geográfica mais próxima. Os mapeamentos de zona personalizada permitem que os administradores substituam esses mapeamentos automáticos. Por exemplo, um caso de uso pode exigir o mapeamento de um código de localização para uma zona geograficamente distante. Os administradores podem gerenciar mapeamentos de zona personalizada com as APIs abaixo e o painel Configuração do cluster global quando você cria ou modifica o cluster global.

Retornar todos os dados dos clusters globais

Retorna todos os namespace managed e mapeamentos de zona personalizados para o cluster global especificado. Managed namespace identificam collection usando o nome do reconhecimento de data center, o separador de pontos e o nome da collection. Os mapeamentos de zona personalizada fazem a correspondência dos códigos de localização ISO 3166-2 com as zonas no cluster global. Para usar esse recurso, a chave da API solicitante deve ter o role de somente leitura do projeto.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster global.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Remover todos os mapeamentos de zona personalizados de um cluster global

Remove todos os mapeamentos de zona personalizados para o cluster global especificado. Um mapeamento de zona personalizado corresponde a um código de localização ISO 3166-2 para uma zona no cluster global. Remover os mapeamentos de zona personalizados restaura o mapeamento padrão. Por padrão, o MongoDB Cloud mapeia cada código de localização para a zona geográfica mais próxima. Para usar esse recurso, a chave de API solicitante deve ter a função de proprietário do projeto.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster global.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Adicionar mapeamentos de zona personalizados a um cluster global

Adicione um ou mais mapeamentos de zona personalizados ao cluster global especificado. Um mapeamento de zona personalizado corresponde a um código de localização ISO 3166-2 para uma zona no cluster global. Por padrão, o MongoDB cloud mapeia cada código de localização para a zona geográfica mais próxima. Para utilizar esse recurso, a chave de API solicitante deve ter o role de proprietário do projeto.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster global.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Mapeamento de zona personalizado para adicionar ao cluster global especificado.

Array de objetos (Zona de cluster global)

Lista que contém pares de valores-chave separados por vírgula para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização ISO 3166-1a2, com um código de subdivisão ISO 3166-2 quando possível, para a etiqueta legível para humanos para a zona personalizada desejada. O MongoDB Cloud mapeia o código ISO 3166-1a2 para a zona geográfica mais próxima por padrão. Inclua este parâmetro para substituir mapeamentos padrão.

Este parâmetro retorna um objeto vazio se não existirem zonas personalizadas.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"customZoneMappings": [{"location": "string",
"zone": "string"
}
]
}

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Remova um namespace gerenciado de um cluster global

Remove um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma coleção utilizando o nome do banco de dados, o separador de pontos e o nome da coleção. A exclusão de um namespace gerenciado não remove a coleção ou os respectivos dados. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso aos dados do projeto".

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster global.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
db	string Rótulo legível por humanos que identifica o banco de dados que contém a coleção.
collection	string Rótulo legível por humanos que identifica a coleção associada ao namespace gerenciado.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Criar um namespace gerenciado em um cluster global

Cria um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma coleção utilizando o nome do banco de dados, o separador de pontos e o nome da coleção. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso aos dados do projeto".

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster global.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Namespace gerenciado a ser criado dentro do cluster global especificado.

collection necessário	string Rótulo legível por humanos da coleção a ser gerenciada para esse cluster global.
db necessário	string Etiqueta legível para humanos do banco de dados a ser gerenciado para este cluster global.
isCustomShardKeyHashed	booleano Padrão: false Sinalizador que indica se alguém fez hash da chave de shard personalizada para a collection especificada. Se você definir esse valor como `false`, o MongoDB cloud usará fragmentação à distância. Hashed shard keys
isShardKeyUnique	booleano Padrão: false Sinalizador que indica se alguém fez hash da chave de shard personalizada. Se este parâmetro retornar `false`, esse cluster usará fragmentação à distância.
numInitialChunks	inteiro <int64> <= 8192 Número mínimo de parte a serem criados inicialmente ao fragmentar uma collection vazia com uma chave de fragmento com hash. Fragmentação de cluster global
presplitHashedZones	booleano Padrão: false Sinalizador que indica se o MongoDB Cloud deve criar e distribuir chunks iniciais para uma collection vazia ou inexistente. O MongoDB Cloud distribui dados com base nas zonas e faixas de zonas definidos para a collection. Chave de fragmento com hash

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"collection": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 8192,
"presplitHashedZones": false
}

Exemplos de resposta

200
400
401
405
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Remover todos os mapeamentos de zona personalizados de um cluster global

Remove todos os mapeamentos de zona personalizados para o cluster global especificado. Um mapeamento de zona personalizado corresponde a um código de localização ISO 3166-2 para uma zona no cluster global. Remover os mapeamentos de zona personalizados restaura o mapeamento padrão. Por padrão, o MongoDB Cloud mapeia cada código de localização para a zona geográfica mais próxima. Para usar esse recurso, a chave de API solicitante deve ter a função de proprietário do projeto.

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Remova um namespace gerenciado de um cluster global

Remove um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma coleção utilizando o nome do banco de dados, o separador de pontos e o nome da coleção. A exclusão de um namespace gerenciado não remove a coleção ou os respectivos dados. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso aos dados do projeto".

Global Clusters

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
db	string Rótulo legível por humanos que identifica o banco de dados que contém a coleção.
collection	string Rótulo legível por humanos que identifica a coleção associada ao namespace gerenciado.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"customZoneMapping": {"property1": "string",
"property2": "string"
},
"managedNamespaces": [{"collection": "string",
"customShardKey": "string",
"db": "string"
}
],
"selfManagedSharding": true
}

Faturas

Retorna faturas.

Retornar todas as faturas de uma organização

Retorna todas as faturas que o MongoDB emitiu para a organização especificada. Esta lista inclui todas as faturas, independentemente do status da fatura. Para usar esse recurso, a chave de API solicitante deve ter a função Visualizador de faturamento da organização, Administrador de faturamento da organização ou Proprietário da organização. Se houver uma configuração de organização cruzada, é possível visualizar as faturas vinculadas se você tiver a função de Administrador de cobrança da organização ou Proprietário da organização. Para calcular o valor total devido das faturas, some o total devido em cada uma das faturas. Pode ser calculado como uma soma do valor devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento, use a fórmula totalBilledCents * unitPrice + salesTax - StartingBalanceCents.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
viewLinkedInvoices	booleano Padrão: true Exemplo: viewLinkedInvoices=true Sinalizador que indica se as faturas vinculadas devem ser retornadas no campo linkedInvoices.
statusNames	Array de strings unique Itens Enum: "PENDENTE" "Fechado" "PERDOADO" "FAILED" "PAGO" "GRÁTIS" "PRÉ-PAGO" "FATURADO" Status da fatura a ser recuperada. Omitir para retornar faturas de todos os status.
fromDate	string <date> Exemplo: fromDate=2023-01-01 Recupere as faturas cujas startDates sejam maiores ou iguais a fromDate. Se omitido, as faturas geradas retornarão para a startDate mais antiga
toDate	string <date> Exemplo: toDate=2023-01-01 Recupere as faturas das quais endpoints são menores ou iguais a toDate. Se omitido, as faturas devolvidas irão além do mais recente endDate.
sortBy	string Padrão: "END_DATE" Enum: "start_date" "END_DATE" Campo usado para classificar as faturas retornadas. Use em combinação com o parâmetro orderBy para controlar a ordem do resultado.
ORDENAR POR	string Padrão: "desc" Enum: "desc" "asc" Exemplo: orderBy=desc Campo usado para ordenar as faturas retornadas. Use em combinação com o parâmetro sortBy para controlar a ordem do resultado.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"amountBilledCents": 0,
"amountPaidCents": 0,
"created": "2019-08-24T14:15:22Z",
"creditsCents": 0,
"endDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"linkedInvoices": [{ }
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 0,
"startDate": "2019-08-24T14:15:22Z",
"startingBalanceCents": 0,
"statusName": "PENDING",
"subtotalCents": 0,
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Retornar todas as faturas pendentes de uma organização

Retorna todas as cobranças acumuladas de faturas para o ciclo de faturamento atual da organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a role Visualizador de faturamento da organização, Administrador de faturamento da organização ou Proprietário da organização. Se você tiver uma configuração de organização cruzada, pode visualizar as faturas vinculadas se tiver a função de Administrador de faturamento da organização ou Proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"amountBilledCents": 0,
"amountPaidCents": 0,
"created": "2019-08-24T14:15:22Z",
"creditsCents": 0,
"endDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"lineItems": [{"clusterName": "string",
"created": "2019-08-24T14:15:22Z",
"discountCents": 0,
"endDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"note": "string",
"percentDiscount": 0,
"quantity": 0,
"sku": "CLASSIC_BACKUP_OPLOG",
"startDate": "2019-08-24T14:15:22Z",
"stitchAppName": "string",
"tags": {"property1": ["string"
],
"property2": ["string"
]
},
"tierLowerBound": 0,
"tierUpperBound": 0,
"totalPriceCents": 0,
"unit": "string",
"unitPriceDollars": 0
}
],
"linkedInvoices": [{ }
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"payments": [{"amountBilledCents": 0,
"amountPaidCents": 0,
"created": "2019-08-24T14:15:22Z",
"currency": "string",
"id": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 0,
"statusName": "NEW",
"subtotalCents": 0,
"unitPrice": "string",
"updated": "2019-08-24T14:15:22Z"
}
],
"refunds": [{"amountCents": 0,
"created": "2019-08-24T14:15:22Z",
"paymentId": "stringstringstringstring",
"reason": "string"
}
],
"salesTaxCents": 0,
"startDate": "2019-08-24T14:15:22Z",
"startingBalanceCents": 0,
"statusName": "PENDING",
"subtotalCents": 0,
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Retornar a fatura de uma organização

Retorna uma fatura que o MongoDB emitiu para a organização especificada. Uma string única de 24 dígitos hexadecimais que identifica a fatura. Você pode optar por receber esta fatura em formato JSON ou CSV. Para usar esse recurso, a chave de API solicitante deve ter a função Visualizador de faturamento da organização, Administrador de faturamento da organização ou Proprietário da organização. Se você tiver uma configuração de organização cruzada, você pode consultar uma fatura vinculada se tiver a função Administrador de faturamento da organização ou Proprietário da organização. Para calcular o valor total devido da fatura, some o valor total devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento, use a fórmula totalBilledCents * unitPrice + salesTax - StartingBalanceCents.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
invoiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a fatura enviada à organização especificada. Normalmente, as cobranças são publicadas no dia seguinte.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"amountBilledCents": 0,
"amountPaidCents": 0,
"created": "2019-08-24T14:15:22Z",
"creditsCents": 0,
"endDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"lineItems": [{"clusterName": "string",
"created": "2019-08-24T14:15:22Z",
"discountCents": 0,
"endDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"note": "string",
"percentDiscount": 0,
"quantity": 0,
"sku": "CLASSIC_BACKUP_OPLOG",
"startDate": "2019-08-24T14:15:22Z",
"stitchAppName": "string",
"tags": {"property1": ["string"
],
"property2": ["string"
]
},
"tierLowerBound": 0,
"tierUpperBound": 0,
"totalPriceCents": 0,
"unit": "string",
"unitPriceDollars": 0
}
],
"linkedInvoices": [{ }
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"payments": [{"amountBilledCents": 0,
"amountPaidCents": 0,
"created": "2019-08-24T14:15:22Z",
"currency": "string",
"id": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 0,
"statusName": "NEW",
"subtotalCents": 0,
"unitPrice": "string",
"updated": "2019-08-24T14:15:22Z"
}
],
"refunds": [{"amountCents": 0,
"created": "2019-08-24T14:15:22Z",
"paymentId": "stringstringstringstring",
"reason": "string"
}
],
"salesTaxCents": 0,
"startDate": "2019-08-24T14:15:22Z",
"startingBalanceCents": 0,
"statusName": "PENDING",
"subtotalCents": 0,
"updated": "2019-08-24T14:15:22Z"
}

Retornar uma fatura da organização como CSV

Retorna uma fatura que o MongoDB emitiu para a organização especificada no formato CSV. Uma string única de 24 dígitos hexadecimais que identifica a fatura. Para usar esse recurso, a chave de API solicitante dever ter pelo menos a função de Visualizador de faturamento da organização, Administrador de cobrança da organização ou Proprietário da organização. Se houver uma configuração de organização cruzada, é possível executar uma query nas faturas vinculadas se você tiver a função de Administrador de cobrança da organização ou Proprietário da organização. Para calcular o valor total devido da fatura, some o valor total devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento - use a fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
invoiceId necessário	string[0-9a-f]+ String única de 24 dígitos hexadecimais que identifica a fatura enviada à organização especificada. Normalmente, as cobranças são publicadas no dia seguinte.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

texto/CSV

Número da fatura,666acb8787ba43606905dcae,
Período de cobrança," 1 de junho de 2024 - 1 de julho de 2024",
Nome da organização,Teste 2,
ID da organização,666acb8787ba43606905dcac,

Data,Uso de data,Descrição,Observação,Nome da organização,ID da organização,Projeto,ID do Projeto,SKU,Região,cluster,Conjunto de réplicas,Config Server,Aplicativo,unidade,Preço unitário,Quantidade,Porcentagem de desconto,Quantia

Configuração LDAP

Retorna, edita, verifica e remove as configurações LDAP. Uma configuração LDAP define as configurações para que o MongoDB Cloud se conecte ao seu servidor LDAP por TLS para a autenticação e autorização do usuário. Seu servidor LDAP deve estar visível na internet ou conectado ao seu cluster do MongoDB Cloud com emparelhamento VPC. Além disso, seu servidor LDAP deve usar TLS. É necessário ter o privilégio de usuário administrador do MongoDB Cloud para usar esses endpoints. Além disso, para configurar a autenticação e a autorização do usuário com LDAPS, seu cluster deve executar o MongoDB 3.6 ou superior. Os grupos para os quais você configurou o LDAPS não podem criar um cluster usando uma versão do MongoDB 3.6 ou inferior.

Retornar a configuração atual do LDAP ou X.509

Retorna a configuração LDAP atual para o projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"customerX509": {"cas": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"ldap": {"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636,
"userToDNMapping": [{"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Editar a configuração LDAP ou X.509

Edita a configuração LDAP para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

A atualização dessa configuração aciona uma reinicialização contínua do banco de dados.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza a configuração LDAP do projeto especificado.

	objeto (Configurações do certificado TLS do utilizador do banco de dados) Configurações para configurar certificados TLS para usuários de banco de dados.
	objeto (Configurações de segurança LDAP) Detalhes de configuração LDAP (Lightweight Directory Access Protocol) sobre TLS (Transport Layer Security) que se aplicam ao projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"customerX509": {"cas": "string"
},
"ldap": {"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindPassword": "string",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"port": 636,
"userToDNMapping": [{"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
}
}

Exemplos de resposta

202
400
404
500

Tipo de conteúdo

aplicação/json

{"customerX509": {"cas": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"ldap": {"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636,
"userToDNMapping": [{"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Remover o usuário LDAP atual para mapeamento DN

Remove o mapeamento atual do LDAP Distinguished Name capturado no documento userToDNMapping da configuração LDAP do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

202
404
500

Tipo de conteúdo

aplicação/json

{"customerX509": {"cas": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"ldap": {"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636,
"userToDNMapping": [{"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Verificar a configuração LDAP em um projeto

Verifica a configuração LDAP para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

A configuração LDAP do projeto especificado que você deseja validar.

authzQueryTemplate	string Padrão: "{USER}?memberOf?base" Modelo de query LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud aplica para criar uma query LDAP para retornar os grupos LDAP associados ao usuário autenticado do MongoDB. O MongoDB Cloud usa este parâmetro apenas para a autorização do usuário. Use o espaço reservado `{USER}` no Localizador de recursos uniforme (URL) para substituir o nome de usuário autenticado. A query está relacionada ao host especificado com o nome do host. Formate esta consulta de acordo com RFC 4515 e RFC 4516.
bindPassword necessário	string Senha que o MongoDB Cloud usa para autenticar o bindUsername.
bindUsername necessário	string^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:... Nome distintivo (DN) completo do usuário LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud usa para se conectar ao host LDAP. Os nomes distintivos do LDAP devem ser formatados de acordo com a RFC 2253. RFC 2253
caCertificate	string Certificado de autoridade de certificação (CA) que o MongoDB Cloud usa para verificar a identidade do host LDAP (Lightweight Directory Access Protocol). MongoDB Cloud permite certificados autoassinados. Para excluir um valor atribuído, passe uma string vazia: `"caCertificate": ""`.
nome do host necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}:)... Etiqueta legível por humanos que identifica o nome do host ou o endereço IP (Internet Protocol) do host LDAP (Lightweight Directory Access Protocol). Esse host deve ter acesso à Internet ou ter uma conexão de emparelhamento de nuvem privada virtual (VPC) com seu cluster.
Porta necessário	inteiro <int32> Padrão: 636 Porta IANA para a qual o host LDAP (Lightweight Directory Access Protocol) escuta conexões de cliente.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"authzQueryTemplate": "{USER}?memberOf?base",
"bindPassword": "string",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"port": 636
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"groupId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"request": {"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636
},
"requestId": "32b6e34b3d91647abb20e7b8",
"status": "FAIL",
"validations": [{"status": "FAIL",
"validationType": "AUTHENTICATE"
}
]
}

Retornar o status de uma solicitação de configuração LDAP de verificação

Retorna o status de uma solicitação de validação de uma configuração LDAP para o projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

requestId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva que identifica a solicitação de validação de uma configuração LDAP.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"groupId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"request": {"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636
},
"requestId": "32b6e34b3d91647abb20e7b8",
"status": "FAIL",
"validations": [{"status": "FAIL",
"validationType": "AUTHENTICATE"
}
]
}

Backup legado

Gerencia snapshots, tarefas de restauração, agendamentos e checkpoints de backups legados.

Retornar todos os checkpoints de backups legados como obsoletos

Retorna todos os checkpoints de backup legado para um cluster no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster que contém os pontos de verificação que pretende devolver.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusterId": "32b6e34b3d91647abb20e7b8",
"completed": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [{"replicaSetName": "string",
"shardName": "string",
"tokenDiscovered": true,
"tokenTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"typeName": "REPLICA_SET"
}
],
"restorable": true,
"started": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

Retornar um checkpoint de backup legado obsoleto

Retorna um checkpoint de backup legado para um cluster no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
checkpointId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o checkpoint.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster que contém os pontos de verificação que pretende devolver.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"completed": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [{"replicaSetName": "string",
"shardName": "string",
"tokenDiscovered": true,
"tokenTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"typeName": "REPLICA_SET"
}
],
"restorable": true,
"started": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z"
}

Retornar todas as tarefas de restauração de backup legado obsoletas

Retornar todas as tarefas de restauração de backup legado para um cluster no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups na nuvem. Quando você faz upgrade para a versão 4.2, seu sistema de backup faz upgrade para o backup na nuvem, caso esteja atualmente definido como backup legado. Após esta atualização, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, deverá recriá-la com o procedimento descrito na documentação do Cloud Backup. Se você utilizar o parâmetro de query do BATCH-ID, você poderá recuperar todos os trabalhos de restauração no lote especificado. Ao criar um trabalho de restauração para um cluster fragmentado, o MongoDB Cloud cria um trabalho separado para cada fragmento, além de outro para o servidor de configuração. Cada um desses trabalhos faz parte de um lote. No entanto, um lote não pode incluir um trabalho de restauração para um conjunto de réplicas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster com o snapshot que você deseja retornar.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
batchId	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o lote de tarefas de restauração a serem retornadas. Registro de data/hora no formato de data e hora ISO 8601 em UTC ao criar uma tarefa de restauração para um cluster fragmentado, o aplicativo cria uma tarefa separada para cada shard, além de outra para o host de configuração. Cada uma destas tarefas compreende um lote. Uma tarefa de restauração para um conjunto de réplicas não pode fazer parte de um lote.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"batchId": "32b6e34b3d91647abb20e7b8",
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"created": "2019-08-24T14:15:22Z",
"delivery": {"authHeader": "string",
"authValue": "string",
"expirationHours": 1,
"expires": "2019-08-24T14:15:22Z",
"maxDownloads": 1,
"methodName": "CLIENT_PIT_HTTP",
"statusName": "NOT_STARTED",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"url": "string",
"urlV2": "string"
},
"encryptionEnabled": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"hashes": [{"fileName": "string",
"hash": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"typeName": "SHA1"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"statusName": "IN_PROGRESS",
"timestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
}
}
],
"totalCount": 0
}

Criação de um trabalho de restauração de backup legado Descontinuado

Restaura um backup legado para um agrupamento no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto". A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Quando você faz upgrade para a versão 4.2, seu sistema de backup faz upgrade para o backup em nuvem, caso esteja atualmente definido como backup legado. Após este upgrade, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. A política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, deverá recriá-la com o procedimento descrito na documentação dos backups em nuvem. Esse ponto de extremidade não oferece suporte à criação de trabalhos de restauração de ponto de verificação para clusters fragmentados nem à criação de trabalhos de restauração para snapshots de backup consultáveis. Se você criar um trabalho de restauração automatizado especificando delivery.methodName de AUTOMATED_RESTORE no corpo da solicitação, o MongoDB Cloud removerá todos os dados existentes no cluster de destino antes da restauração.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster com o snapshot que você deseja retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Backup legado para restaurar em um cluster no projeto especificado.

checkpointId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o checkpoint fragmentado do cluster. O checkpoint representa o ponto no tempo de retorno para o qual você deseja restaurar seus dados. Esse parâmetro se aplica quando `"delivery.methodName" : "AUTOMATED_RESTORE"`. Use esse parâmetro somente com clusters fragmentados. Se você definir checkpointId, não poderá definir oplogInc, oplogTs, snapshotId ou pointInTimeUTCMillis. Se você fornecer esse parâmetro, esse ponto de extremidade restaurará todos os dados até esse ponto de verificação para o banco de dados especificado no objeto delivery
necessário	objeto (Restaurar metadados de entrega de snapshot) Método e detalhes que indicam como entregar os dados de snapshot restaurados.
oplogInc	inteiro <int32> >= 1 Ordinal incrementado de trinta e dois bits que representa operações em um determinado segundo. Quando emparelhado com oplogTs, isso representa o ponto no tempo para o qual o MongoDB Cloud restaura seus dados. Este parâmetro se aplica quando `"delivery.methodName" : "AUTOMATED_RESTORE"`. Se configurar oplogInc, você deverá configurar oplogTs e não poderá configurar checkpointId, snapshotId ou pointInTimeUTCMillis. Se você fornecer esse parâmetro, esse ponto de extremidade restaurará todos os dados até e incluindo este carimbo de data/hora Oplog no banco de dados especificado no objeto delivery.
oplogTs	string^(?:[1-9]\\d{3}-(?:(?:0[1-9]\|1[0-2])-(?:0[1-9... Data e hora a partir das quais você deseja restaurar esse snapshot. Este parâmetro expressa seu valor no formato ISO 8601 em UTC. Isso representa a primeira parte de um carimbo de data/hora do Oplog. Quando emparelhados com o oploginc, eles representam a última operação de banco de dados para a qual você deseja restaurar seus dados. Esse parâmetro se aplica quando `"delivery.methodName" : "AUTOMATED_RESTORE"`. Execute uma consulta em local.oplog.rs em seu conjunto de réplicas para encontrar o carimbo de data/hora desejado. Se você definir oplogTs, deverá definir oplogInc e não poderá definir checkpointId, snapshotId ou pointInTimeUTCMillis. Se você fornecer esse parâmetro, esse ponto de extremidade restaurará todos os dados até e incluindo este carimbo de data/hora Oplog no banco de dados especificado no objeto delivery.
pointInTimeUTCMillis	inteiro <int64> >= 1199145600000 Carimbo de data/hora a partir do qual pretende restaurar esse snapshot. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX. Esse carimbo de data/hora deve cair nas últimas 24 horas da hora atual. Esse parâmetro se aplica quando `"delivery.methodName" : "AUTOMATED_RESTORE"`. Se você fornecer esse parâmetro, esse ponto de extremidade restaurará todos os dados até esse momento no banco de dados especificado no objeto delivery. Se você definir pointInTimeUTCMillis, não poderá definir oplogInc, oplogTs, snapshotId ou checkpointId.
snapshotId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o snapshot a ser restaurado. Se você definir snapshotId, não poderá definir oplogInc, oplogTs, pointInTimeUTCMillis ou checkpointId.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"checkpointId": "32b6e34b3d91647abb20e7b8",
"delivery": {"expirationHours": 1,
"maxDownloads": 1,
"methodName": "CLIENT_PIT_HTTP",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
},
"oplogInc": 1,
"oplogTs": "string",
"pointInTimeUTCMillis": 1199145600000,
"snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"batchId": "32b6e34b3d91647abb20e7b8",
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"created": "2019-08-24T14:15:22Z",
"delivery": {"authHeader": "string",
"authValue": "string",
"expirationHours": 1,
"expires": "2019-08-24T14:15:22Z",
"maxDownloads": 1,
"methodName": "CLIENT_PIT_HTTP",
"statusName": "NOT_STARTED",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"url": "string",
"urlV2": "string"
},
"encryptionEnabled": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"hashes": [{"fileName": "string",
"hash": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"typeName": "SHA1"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"statusName": "IN_PROGRESS",
"timestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
}
}
],
"totalCount": 0
}

Retornar uma tarefa de restauração de backup legado obsoleta

Retorna uma tarefa de restauração de backup legado para um cluster no projeto especificado. Para usar este recurso, a chave da API solicitante deve ter a role Somente leitura do projeto.

A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Ao atualizar para a versão 4.2, seu sistema de backup atualiza para o backup em nuvem, caso esteja atualmente definido como backup legado. Após a atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, será necessário recriá-la seguindo o procedimento descrito na documentação de backup em nuvem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica o cluster com o snapshot que você deseja retornar.
jobId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"batchId": "32b6e34b3d91647abb20e7b8",
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"created": "2019-08-24T14:15:22Z",
"delivery": {"authHeader": "string",
"authValue": "string",
"expirationHours": 1,
"expires": "2019-08-24T14:15:22Z",
"maxDownloads": 1,
"methodName": "CLIENT_PIT_HTTP",
"statusName": "NOT_STARTED",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"url": "string",
"urlV2": "string"
},
"encryptionEnabled": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"hashes": [{"fileName": "string",
"hash": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"typeName": "SHA1"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"statusName": "IN_PROGRESS",
"timestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
}
}

Retornar um agendamento de snapshot obsoleto

Retorna o agendamento de snapshots para um cluster no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Ao atualizar para a versão 4.2, seu sistema de backup atualiza para o backup em nuvem, caso esteja atualmente definido como backup legado. Após a atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, será necessário recriá-la seguindo o procedimento descrito na documentação de backup em nuvem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster com o snapshot que você deseja retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"clusterCheckpointIntervalMin": 15,
"clusterId": "32b6e34b3d91647abb20e7b8",
"dailySnapshotRetentionDays": 0,
"groupId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"monthlySnapshotRetentionMonths": 0,
"pointInTimeWindowHours": 0,
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 2,
"weeklySnapshotRetentionWeeks": 0
}

Atualizar agendamento de snapshots para um cluster obsoleto

Atualiza o agendamento de snapshots para um cluster no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Ao atualizar para a versão 4.2, seu sistema de backup atualiza para o backup em nuvem, caso esteja atualmente definido como backup legado. Após a atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, será necessário recriá-la seguindo o procedimento descrito na documentação de backup em nuvem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica o cluster com o snapshot que você deseja retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualize o agendamento de snapshots para um cluster no projeto especificado.

clusterCheckpointIntervalMin necessário	inteiro <int32> Enum: 15 30 60 Quantidade de tempo expressa em minutos entre os checkpoints de cluster sucessivos. Este parâmetro se aplica somente a clusters fragmentados. Esse número determina a granularidade dos backups em nuvem contínuos para clusters fragmentados.
clusterId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o cluster com o snapshot que você deseja retornar.
dailySnapshotRetentionDays necessário	inteiro <int32> Enum: 0 3 4 5 6 7 15 30 60 90 120 180 360 Quantidade de tempo para manter snapshots diários. O MongoDB Cloud expressa esse valor em dias. Defina esse valor como `0` para desabilitar a retenção diária de snapshots.
montlySnapshotRetentionMonths necessário	inteiro <int32> Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 18 24 36 Número de meses que o MongoDB Cloud deve manter snapshots mensais. Defina esse valor como `0` para desabilitar a retenção mensal de snapshots.
pointInTimeWindowHours necessário	inteiro <int32> Número de horas antes da hora atual a partir da qual o MongoDB Cloud pode criar um snapshot contínuo de backups em nuvem.
snapshotIntervalHours necessário	inteiro <int32> Enum: 6 8 12 24 Número de horas que devem passar antes de fazer outro snapshot.
snapshotRetentionDays necessário	inteiro <int32> Enum: 2 3 4 5 Número de dias que o MongoDB Cloud deve manter snapshots recentes.
weeklySnapshotRetentionWeeks necessário	inteiro <int32> Enum: 0 1 2 3 4 5 6 7 8 12 16 20 24 52 Número de semanas que o MongoDB Cloud deve manter snapshots semanais. Defina esse valor como `0` para desabilitar a retenção semanal de snapshots.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"clusterCheckpointIntervalMin": 15,
"clusterId": "32b6e34b3d91647abb20e7b8",
"dailySnapshotRetentionDays": 0,
"monthlySnapshotRetentionMonths": 0,
"pointInTimeWindowHours": 0,
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 2,
"weeklySnapshotRetentionWeeks": 0
}

Exemplos de resposta

200
400
500

Tipo de conteúdo

aplicação/json

{"clusterCheckpointIntervalMin": 15,
"clusterId": "32b6e34b3d91647abb20e7b8",
"dailySnapshotRetentionDays": 0,
"groupId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"monthlySnapshotRetentionMonths": 0,
"pointInTimeWindowHours": 0,
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 2,
"weeklySnapshotRetentionWeeks": 0
}

Retornar todos os snapshots de backups legados obsoleto

Retorna todos os snapshots de backups legados para um cluster no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto. A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Ao atualizar para a versão 4.2, seu sistema de backup atualiza para o backup em nuvem, caso esteja atualmente definido como backup legado. Após a atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, será necessário recriá-la seguindo o procedimento descrito na documentação de backup em nuvem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
concluído	string Padrão: "verdadeiro" Enum: "all" "verdadeiro" "falso" Etiqueta legível para humanos que especifica se deseja retornar somente os snapshots completos, incompletos ou todos os snapshots. Por padrão, o MongoDB Cloud retorna apenas snapshots completos.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"complete": true,
"created": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"doNotDelete": true,
"expires": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"incremental": true,
"lastOplogAppliedTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [{"clusterId": "32b6e34b3d91647abb20e7b8",
"completedTime": "2019-08-24T14:15:22Z",
"compressionSetting": "NONE",
"dataSizeBytes": 0,
"encryptionEnabled": true,
"fcv": "string",
"fileSizeBytes": 0,
"machineId": "string",
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"replicaSetName": "string",
"replicaState": "string",
"storageSizeBytes": 0,
"typeName": "REPLICA_SET"
}
]
}
],
"totalCount": 0
}

Remover um snapshot de backup legado obsoleto

Remove um snapshot de backup legado para um cluster no projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto". A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups na nuvem. Quando você faz upgrade para a versão 4.2, seu sistema de backup faz upgrade para o backup na nuvem, caso esteja atualmente definido como backup legado. Após esta atualização, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, deverá recriá-la com o procedimento descrito na documentação do Cloud Backup.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um snapshot de backup legado obsoleto

Retorna um snapshot de backup legado para um cluster no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto. A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups na nuvem. Quando você faz upgrade para a versão 4.2, seu sistema de backup faz upgrade para o backup na nuvem, caso esteja atualmente definido como backup legado. Após esta atualização, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, deverá recriá-la com o procedimento descrito na documentação do Cloud Backup.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"complete": true,
"created": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"doNotDelete": true,
"expires": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"incremental": true,
"lastOplogAppliedTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [{"clusterId": "32b6e34b3d91647abb20e7b8",
"completedTime": "2019-08-24T14:15:22Z",
"compressionSetting": "NONE",
"dataSizeBytes": 0,
"encryptionEnabled": true,
"fcv": "string",
"fileSizeBytes": 0,
"machineId": "string",
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"replicaSetName": "string",
"replicaState": "string",
"storageSizeBytes": 0,
"typeName": "REPLICA_SET"
}
]
}

Alteração da expiração de um snapshot de backup legado obsoleto

Altera a data de validade de um snapshot de backup legado para um cluster no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto. A partir de 23 de março de 2020, todos os novos clusters poderão usar apenas backups em nuvem. Ao atualizar para a versão 4.2, seu sistema de backup atualiza para o backup em nuvem, caso esteja atualmente definido como backup legado. Após a atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tiver uma política de backup personalizada em vigor com backups legados, será necessário recriá-la seguindo o procedimento descrito na documentação de backup em nuvem.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Altera a expiração de um snapshot de backup legado.

doNotDelete	booleano Sinalizador que indica se alguém pode excluir esse snapshot. Não é possível definir `"doNotDelete" : true` e definir um registro de data e hora com expiração na mesma solicitação.
expira	string <date-time> Data e hora em que o MongoDB Cloud exclui o snapshot. Se `"doNotDelete" : true`, o MongoDB Cloud removerá qualquer valor definido para este parâmetro.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"doNotDelete": true,
"expires": "2019-08-24T14:15:22Z"
}

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"complete": true,
"created": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"doNotDelete": true,
"expires": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"incremental": true,
"lastOplogAppliedTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [{"clusterId": "32b6e34b3d91647abb20e7b8",
"completedTime": "2019-08-24T14:15:22Z",
"compressionSetting": "NONE",
"dataSizeBytes": 0,
"encryptionEnabled": true,
"fcv": "string",
"fileSizeBytes": 0,
"machineId": "string",
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"replicaSetName": "string",
"replicaState": "string",
"storageSizeBytes": 0,
"typeName": "REPLICA_SET"
}
]
}

Janelas de manutenção

Retorna, edita e remove janelas de manutenção. O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma escolha de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas. Você pode adiar um evento de manutenção agendado para um projeto até duas vezes. Os eventos de manutenção adiados ocorrem durante a janela de manutenção de sua preferência, exatamente uma semana após a data e a hora agendadas anteriormente.

Redefinir uma janela de manutenção para um projeto

Redefine a janela de manutenção do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto". Atividades de manutenção urgentes, como patches de segurança, não podem esperar pela janela escolhida. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Depois de agendar a manutenção para o cluster, você não poderá alterar a janela de manutenção até que o trabalho de manutenção vigente seja concluído . O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma escolha de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível da hora agendada, mas atualizações de cluster em andamento ou problemas inesperados do sistema podem atrasar a hora de início. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Retornar uma janela de manutenção para um projeto

Retorna a janela de manutenção do projeto especificado. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Você não pode alterar sua janela de manutenção até que o trabalho de manutenção atual seja concluído. O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma eleição de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível do horário agendado, mas atualizações do cluster em andamento ou problemas inesperados no sistema podem atrasar o horário de início. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"autoDeferOnceEnabled": true,
"dayOfWeek": 1,
"hourOfDay": 23,
"numberOfDeferrals": 0,
"startASAP": true
}

Atualizar janela de manutenção para um projeto

Atualiza a janela de manutenção do projeto especificado. Atividades de manutenção urgentes, como patches de segurança, não podem esperar pela janela escolhida. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Depois de agendar a manutenção para o cluster, você não poderá alterar a janela de manutenção até que o trabalho de manutenção vigente seja concluído . O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma escolha de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível da hora agendada, mas atualizações de cluster em andamento ou problemas inesperados do sistema podem atrasar a hora de início. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Atualiza a janela de manutenção do projeto especificado.

autoDeferOnceEnabled

booleano

Sinalizador que indica se o MongoDB Cloud deve adiar todas as janelas de manutenção por uma semana após sua ativação.

dayOfWeek

necessário

inteiro <int32> [ 1 .. 7 ]

Um inteiro baseado que representa o dia da semana em que a janela de manutenção é iniciada.

Valor	Dia da semana
`1`	Domingo
`2`	Segunda-feira
`3`	Terça-feira
`4`	Quarta-feira
`5`	Quinta-feira
`6`	Sexta-feira
`7`	Sábado

hourOfDay

inteiro <int32> [ 0 .. 23 ]

Número inteiro com base zero que representa a hora do dia em que a janela de manutenção começa, de acordo com um relógio de 24 horas. Use 0 para meia-noite e 12 para meio-dia.

startASAP

booleano

Sinalizador que indica se o MongoDB Cloud inicia a janela de manutenção imediatamente após o recebimento dessa solicitação. Para iniciar a janela de manutenção imediatamente para seu projeto, o MongoDB Cloud deve ter a manutenção agendada e você deve definir uma janela de manutenção. Esse sinalizador é redefinido para false após a conclusão da manutenção do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"autoDeferOnceEnabled": true,
"dayOfWeek": 1,
"hourOfDay": 23,
"startASAP": true
}

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Alternar adiamento automático de manutenção para um projeto

Alterna o adiamento automático da janela de manutenção do projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Adiar uma janela de manutenção para um projeto

Adia a janela de manutenção para o projeto especificado. Atividades de manutenção urgentes, como patches de segurança, não podem aguardar a janela escolhida. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Depois de agendar a manutenção para o cluster, você não poderá alterar a janela de manutenção até que o trabalho de manutenção atual seja concluído. O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma eleição de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível do horário agendado, mas atualizações do cluster em andamento ou problemas inesperados no sistema podem atrasar o horário de início. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Usuários do MongoDB Cloud

Retorna, adiciona e edita usuários do MongoDB Cloud.

Criar um usuário da nuvem MongoDB

Cria uma conta de usuário do MongoDB Cloud. Uma conta de usuário do MongoDB Cloud concede acesso apenas ao aplicativo do MongoDB Cloud. Para conceder acesso ao banco de dados, crie um usuário de banco de dados. O MongoDB Cloud envia um e-mail para os usuários que você especificar, convidando-os para participar do projeto. Os usuários convidados não terão acesso ao projeto até que aceitem o convite. Os convites expiram após 30 dias.

O MongoDB Cloud limita a adesão de usuários do MongoDB Cloud a um máximo de 250 por equipe. O MongoDB Cloud limita a adesão de usuários do MongoDB Cloud a 500 por projeto e 500 por organização, o que inclui a adesão combinada de todos os projetos na organização. O MongoDB Cloud emitirá um erro se uma operação exceder esses limites. Por exemplo, se você tiver uma organização com cinco projetos e cada projeto tiver 100 usuários do MongoDB Cloud, e cada usuário pertencer a apenas um projeto, não será possível adicionar nenhum usuário a essa organização sem primeiro remover os usuários existentes da organização.

Para usar esse recurso, a chave de API solicitante pode ter qualquer role.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Conta de usuário do MongoDB Cloud a ser criada.

País necessário	string^([A-Z]{2})$ Dois caracteres alfabéticos que identificam a localização geográfica do usuário do MongoDB Cloud. Este parâmetro utiliza o formato de código ISO 3166-1a2.
Nome necessário	string Nome que pertence ao usuário do MongoDB Cloud.
Sobrenome necessário	string Sobrenome que pertence ao usuário MongoDB Cloud.
mobileNumber necessário	string(?:(?:\\+?1\\s(?:[.-]\\s)?)?(?:(\\s*([2-9]1... Número de celular que pertence ao usuário MongoDB Cloud.
Senha necessário	string >= 8 caracteres Senha aplicada com o nome de usuário para conectar ao MongoDB Cloud. O MongoDB Cloud não retorna esse parâmetro, exceto em resposta à criação de um novo usuário do MongoDB Cloud. Somente o usuário do MongoDB Cloud pode atualizar sua senha depois que ela tiver sido definida no console do MongoDB Cloud.
	Array de objetos (Atribuição de função) Lista de objetos que exibem as roles do usuário do MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Uma role pode se aplicar a uma organização ou a um projeto, mas não a ambos.
nome de usuário necessário	string <email> Endereço de e-mail que representa o nome de usuário do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"country": "string",
"firstName": "string",
"lastName": "string",
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"username": "user@example.com"
}

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Retornar um usuário da nuvem MongoDB usando o nome de usuário dele

Retorna os detalhes de uma conta de usuário MongoDB Cloud com o nome de usuário especificado. Você não pode usar esse ponto de conexão para retornar informações sobre uma chave de API. Para retornar informações sobre uma chave de API, use o ponto de extremidade da chave de API Return One Organization. Para usar esse recurso, a chave de API solicitante pode ter qualquer função.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

userName

necessário

string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%...

Endereço de e-mail que pertence à conta de usuário MongoDB Cloud. Você não pode modificar este endereço após criar o usuário.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Retornar um usuário do MongoDB Cloud usando seu ID

Retorna os detalhes de uma conta de usuário do MongoDB Cloud com o identificador exclusivo especificado para o usuário. Não é possível usar esse endpoint para retornar informações sobre uma chave de API. Para retornar informações sobre uma chave de API, use o endpoint de chave de API Retornar uma organização. Você sempre pode recuperar sua própria conta de usuário. Se você for o proprietário de uma organização ou projeto do MongoDB Cloud, também poderá recuperar o perfil de usuário de qualquer usuário com uma adesão a essa organização ou projeto. Para usar esse recurso, a chave de API solicitante pode ter qualquer role.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

ID do usuário

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica este usuário.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Monitoramento e registros

Retorna o monitoramento do sistema de banco de dados e dados de registro.

Baixar registro para um host de cluster em um projeto

Retorna um arquivo de arquivo de log compactado (.gz) que contém uma faixa de mensagens de log para o host especificado para o projeto especificado. O MongoDB atualiza os logs de processo e auditar da infraestrutura de backend do cluster a cada cinco minutos. Os registros são armazenados em blocos de aproximadamente cinco minutos de duração, mas essa duração pode variar. Se você pesquisar arquivos de log na API, recomendamos a sondagem a cada cinco minutos, embora as sondagens consecutivas possam conter alguns registros sobrepostos. Esse recurso não está disponível para clusters M0 gratuitos, clusters M2, M5 ou clusters sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a role Somente leitura de acesso a dados do projeto ou superior. A API API não suporta chamadas diretas com o JSON esquema de resposta JSON. Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.YYYY-MM-DD+gzip".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
hostName necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}:)... Etiqueta legível por humanos que identifica o host que armazena os arquivos de log que você deseja baixar.
logName necessário	string Enum: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log" Rótulo legível por humanos que identifica o arquivo de registro que você deseja retornar. Para retornar registros de auditoria, habilite a auditoria de banco de dados para o projeto especificado. Configurar auditoria de banco de dados

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
endDate	inteiro <int64> >= 1199145600 Especifica a data e a hora do ponto final do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a UNIX epoch. Esse valor terá como padrão 24 horas após a data de início. Se a data de início também não for especificada, o valor será padronizado para a hora da solicitação.
startDate	inteiro <int64> >= 1199145600 Especifica a data e a hora do ponto de partida do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a época do UNIX. Esse valor terá como padrão 24 horas antes da data final. Se a data de término também não for especificada, o valor padrão será 24 horas antes da hora da solicitação.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

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

Retornar todos os tipos de métricas do Atlas Search para um processo

Retorna todos os tipos de métrica do Atlas Search disponíveis para um processo no projeto especificado. Você deve ter a função "somente leitura" do projeto ou superior para visualizar os tipos de métricas do Atlas Search.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: my.host.name.com:27017

Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"groupId": "32b6e34b3d91647abb20e7b8",
"hardwareMetrics": [{"metricName": "INDEX_SIZE_ON_DISK",
"units": "BYTES"
}
],
"indexMetrics": [{"metricName": "INDEX_SIZE_ON_DISK",
"units": "BYTES"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"statusMetrics": [{"metricName": "INDEX_SIZE_ON_DISK",
"units": "BYTES"
}
]
}

Retornar todas as métricas de índice do Atlas Search para um namespace

Retorna as métricas de índice do Atlas Search dentro da faixa de tempo especificada para um namespace no processo especificado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: my.host.name.com:27017 Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.
Nome do Banco de Dados necessário	string Exemplo: mydb Rótulo legível por humanos que identifica o banco de dados.
collectionName necessário	string Exemplo: mycoll Etiqueta legível para humanos que identifica a collection.
groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.

parâmetros de query

granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.
envelope	booleano Padrão: false Exemplo: envelope=false 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.
metrics necessário	Array de strings <= 10 itens unique Itens Enum: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES" Lista que contém as medições que o MongoDB Atlas relata para a série de dados associada.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"collectionName": "string",
"databaseName": "string",
"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"indexIds": ["32b6e34b3d91647abb20e7b8"
],
"indexStatsMeasurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

Retornar métricas do Atlas Search para um índice em um namespace especificado

Retorna a série de dados de métricas do Atlas Search dentro da faixa de tempo fornecida para um namespace e nome de índice no processo especificado. Você deve ter a role somente leitura do projeto ou superior para visualizar os tipos de métricas do Atlas Search.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: my.host.name.com:27017 Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.
indexName necessário	string Exemplo: myindex Etiqueta legível para humanos que identifica o índice.
Nome do Banco de Dados necessário	string Exemplo: mydb Rótulo legível por humanos que identifica o banco de dados.
collectionName necessário	string Exemplo: mycoll Etiqueta legível para humanos que identifica a collection.
groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.

parâmetros de query

granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.
envelope	booleano Padrão: false Exemplo: envelope=false 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.
metrics necessário	Array de strings <= 10 itens unique Itens Enum: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES" Lista que contém as medições que o MongoDB Atlas relata para a série de dados associada.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"collectionName": "string",
"databaseName": "string",
"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"indexIds": ["32b6e34b3d91647abb20e7b8"
],
"indexStatsMeasurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

Retornar métricas de status e hardware do Atlas Search

Retorna a série de dados de status e hardware do Atlas Search dentro da faixa de tempo fornecida para um processo no projeto especificado. Você deve ter a role Somente leitura do projeto ou superior para visualizar os tipos de métricas do Atlas Search.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: my.host.name.com:27017

Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.
envelope	booleano Padrão: false Exemplo: envelope=false 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.
metrics necessário	Array de strings <= 10 itens unique Itens Enum: "FTS_DISK_USAGE" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "FTS_PROCESS_RESIDENT_MEMORY" "FTS_PROCESS_SHARED_MEMORY" "FTS_PROCESS_VIRTUAL_MEMORY" "JVM_CURRENT_MEMORY" "JVM_MAX_MEMORY" "PAGE_FAULTS" Lista que contém as métricas que você deseja que o MongoDB Atlas relate para a série de dados associada. Se você não definir esse parâmetro, o recurso retornará todas as métricas de hardware e status para a série de dados associada.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hardwareMeasurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z",
"statusMeasurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
]
}

Retornar todos os processos do MongoDB em um projeto

Retorna detalhes de todos os processos do projeto especificado. Um processo do MongoDB pode ser mongod ou mongos. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"created": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostname": "string",
"id": "string",
"lastPing": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 0,
"replicaSetName": "string",
"shardName": "string",
"typeName": "REPLICA_PRIMARY",
"userAlias": "string",
"version": "string"
}
],
"totalCount": 0
}

Retornar um processo do MongoDB por ID

Retorna os processos do host especificado para o projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a função de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: mongodb.example.com:27017

Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"created": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostname": "string",
"id": "string",
"lastPing": "2019-08-24T14:15:22Z",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 0,
"replicaSetName": "string",
"shardName": "string",
"typeName": "REPLICA_PRIMARY",
"userAlias": "string",
"version": "string"
}

Retornar bancos de dados disponíveis para um processo do MongoDB

Retorna a lista de bancos de dados que estão sendo executados no host especificado para o projeto especificado. Clusters livres M0, clusters M2, M5 e clusters sem servidor têm alguns limites operacionais. O processo do MongoDB Cloud deve ser mongod. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: mongodb.example.com:27017

Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome de host, nome de domínio totalmente qualificado (FQDN) ou endereço de protocolo de Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"databaseName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Retornar um banco de dados para um processo do MongoDB

Retorna um banco de dados que está sendo executado no host especificado para o projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
Nome do Banco de Dados necessário	string Rótulo legível por humanos que identifica o banco de dados ao qual o processo MongoDB especificado atende.
processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: mongodb.example.com:27017 Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (`mongod` ou `mongos`). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"databaseName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Retornar medidas de um banco de dados para um processo do MongoDB

Retorna as medições de um banco de dados para o host especificado do projeto especificado. Retorna o espaço de armazenamento no disco do banco de dados com base na saída do comando MongoDB dbStats. Para calcular algumas séries de métricas, o Atlas obtém a taxa entre cada dois pontos adjacentes. Para esta série de métricas, o primeiro ponto de dados tem um valor nulo, pois o Atlas não pode calcular uma taxa para o primeiro ponto de dados dado o intervalo de tempo da query. O Atlas recupera métricas do banco de dados a cada 20 minutos, mas reduz a frequência quando necessário para otimizar o desempenho do banco de dados. Para usar este recurso, a chave de API solicitante deve possuir a função de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
Nome do Banco de Dados necessário	string Rótulo legível por humanos que identifica o banco de dados ao qual o processo MongoDB especificado atende.
processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: mongodb.example.com:27017 Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (`mongod` ou `mongos`). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
m	Array de strings [ 1 ... 10 ] itens unique Itens Enum: "DATABASE_AVERAGE_OBJECT_SIZE" "DATABASE_COLLECTION_COUNT" "DATABASE_DATA_SIZE" "DATABASE_STORAGE_SIZE" "DATABASE_INDEX_SIZE" "DATABASE_INDEX_COUNT" "DATABASE_EXTENT_COUNT" "DATABASE_OBJECT_COUNT" "DATABASE_VIEW_COUNT" Um ou mais tipos de medição a serem solicitados para esse processo do MongoDB. Se omitido, o recurso retorna todas as medições. Para especificar valores múltiplos para `m`, repita o parâmetro `m` para cada valor. Especifique as medições que se aplicam ao host especificado. O MongoDB Cloud retornará um erro se você especificar um medição inválida.
granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"databaseName": "string",
"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

Retornar discos disponíveis para um processo do MongoDB

Retorna a lista de discos ou partições para o host especificado do projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: mongodb.example.com:27017

Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"partitionName": "string"
}
],
"totalCount": 0
}

Retornar medidas de um disco

Retorna detalhes de medição de um disco ou partição do host especificado para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

partitionName necessário	string Etiqueta legível por humanos do disco ou partição à qual as medições se aplicam.
groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: mongodb.example.com:27017 Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (`mongod` ou `mongos`). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"partitionName": "string"
}

Retornar medidas de um disco para um processo do MongoDB

Retorna as medidas de um disco ou partição para o host especificado para o projeto especificado. O valor retornado pode ser um dos seguintes:

Taxa de transferência das operações de E/S para a partição de disco usada para o processo do MongoDB
Porcentagem de tempo durante a qual é feita a solicitação da partição emitida e atendida
Latência por tipo de operação da partição de disco usada para o processo do MongoDB
Quantidade de espaço em disco livre e usada na partição de disco usada para o processo MongoDB

Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
partitionName necessário	string Etiqueta legível por humanos do disco ou partição à qual as medições se aplicam.
processId necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}\:... Exemplo: mongodb.example.com:27017 Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (`mongod` ou `mongos`). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
m	Array de strings [ 1 ... 10 ] itens unique Itens Enum: "DISK_PARTITION_IOPS_READ" "MAX_DISK_PARTITION_IOPS_READ" "DISK_PARTITION_IOPS_WRITE" "MAX_DISK_PAROPHYLLUM_IOPS_WRITE" "DISK_PARTITION_IOPS_TOTAL" "MAX_DISK_PARTITION_IOPS_TOTAL" "DISK_PARTITION_LATENCY_READ" "MAX_DISK_PARTITION_LATENCY_READ" "DISK_PARTITION_LATENCY_WRITE" "MAX_DISK_PARTITION_LATENCY_WRITE" "DISK_PARTITION_SPACE_FREE" "MAX_DISK_PARTITION_SPACE_FREE" "DISK_PARTITION_SPACE_USED" "MAX_DISK_PARTITION_SPACE_USED" "DISK_PARTITION_SPACE_PERCENT_FREE" "MAX_DISK_PARTITION_SPACE_PERCENT_FREE" "DISK_PARTITION_SPACE_PERCENT_USED" "MAX_DISK_PARTITION_SPACE_PERCENT_USED" "DISK_PARTITION_THROUGHPUT_READ" "DISK_PARTITION_THROUGHPUT_WRITE" "DISK_QUEUE_DEPTH" Um ou mais tipos de medição a serem solicitados para esse processo do MongoDB. Se omitido, o recurso retorna todas as medições. Para especificar valores múltiplos para `m`, repita o parâmetro `m` para cada valor. Especifique as medições que se aplicam ao host especificado. O MongoDB Cloud retornará um erro se você especificar um medição inválida.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"databaseName": "string",
"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

Retornar medidas para um processo do MongoDB

Retorna medições de disco, partição ou host por processo para o host especificado para o projeto especificado. O valor retornado pode ser um dos seguintes:

Taxa de transferência das operações de E/S para a partição de disco usada para o processo do MongoDB
Porcentagem de tempo durante a qual é feita a solicitação da partição emitida e atendida
Latência por tipo de operação da partição de disco usada para o processo do MongoDB
Quantidade de espaço em disco livre e usada na partição de disco usada para o processo MongoDB
Medições para o host, como uso de CPU ou número de operações de entrada/saída

Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Exemplo: mongodb.example.com:27017

Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
m	Array de strings [ 1 ... 10 ] itens unique Itens Enum: "ASSERT_MSG" "ASSERT_REGULAR" "ASSERT_USER" "ASSERT_WARNING" "BACKGROUND_FLUSH_AVG" "CACHE_BYTES_READ_INTO" "CACHE_BYTES_WRITTEN_FROM" "CACHE_DIRTY_BYTES" "CACHE_USED_BYTES" "CACHE_FILL_RATIO" "DIRTY_FILL_RATIO" "COMPUTED_MEMORY" "CONNECTIONS" "CURSORS_TOTAL_OPEN" "CURSORS_TOTAL_TIMED_OUT" "DB_DATA_SIZE_TOTAL" "DB_STORAGE_TOTAL" "DOCUMENT_METRICS_DELETED" "DOCUMENT_METRICS_INSERTED" "DOCUMENT_METRICS_RETURNED" "DOCUMENT_METRICS_UPDATED" "EXTRA_INFO_PAGE_FAULTS" "FTS_DISK_UTILIZATION" "FTS_MEMORY_MAPPED" "FTS_MEMORY_RESIDENT" "FTS_MEMORY_VIRTUAL" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "GLOBAL_ACCESSES_NOT_IN_MEMORY" "GLOBAL_LOCK_CURRENT_QUEUE_READERS" "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" "INDEX_COUNTERS_BTREE_ACCESSES" "INDEX_COUNTERS_BTREE_HITS" "INDEX_COUNTERS_BTREE_MISS_RATIO" "INDEX_COUNTERS_BTREE_MISSES" "JOURNALING_COMMITS_IN_WRITE_LOCK" "JOURNALING_MB" "JOURNALING_WRITE_DATA_FILES_MB" "MAX_PROCESS_CPU_CHILDREN_KERNEL" "MAX_PROCESS_CPU_CHILDREN_USER" "MAX_PROCESS_CPU_KERNEL" "MAX_PROCESS_CPU_USER" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER" "MAX_PROCESS_NORMALIZED_CPU_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_USER" "MAX_SWAP_USAGE_FREE" "MAX_SWAP_USAGE_USED " "MAX_SYSTEM_CPU_GUEST" "MAX_SYSTEM_CPU_IOWAIT" "MAX_SYSTEM_CPU_IRQ" "MAX_SYSTEM_CPU_KERNEL" "MAX_SYSTEM_CPU_SOFTIRQ" "MAX_SYSTEM_CPU_STEAL" "MAX_SYSTEM_CPU_USER" "MAX_SYSTEM_MEMORY_AVAILABLE" "MAX_SYSTEM_MEMORY_FREE" "MAX_SYSTEM_MEMORY_USED" "MAX_SYSTEM_NETWORK_IN" "MAX_SYSTEM_NETWORK_OUT" "MAX_SYSTEM_NORMALIZED_CPU_GUEST" "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT" "MAX_SYSTEM_NORMALIZED_CPU_IRQ" "MAX_SYSTEM_NORMALIZED_CPU_KERNEL" "MAX_SYSTEM_NORMALIZED_CPU_NICE" "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ" "MAX_SYSTEM_NORMALIZED_CPU_STEAL" "MAX_SYSTEM_NORMALIZED_CPU_USER" "MEMORY_MAPPED" "MEMORY_RESIDENT" "MEMORY_VIRTUAL" "NETWORK_BYTES_IN" "NETWORK_BYTES_OUT" "NETWORK_NUM_REQUESTS" "OP_EXECUTION_TIME_COMMANDS" "OP_EXECUTION_TIME_READS" "OP_EXECUTION_TIME_WRITES" "OPCOUNTER_CMD" "OPCOUNTER_DELETE" "OPCOUNTER_TTL_DELETED" "OPCOUNTER_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "OPERATIONS_QUERIES_KILLED" "OPLOG_MASTER_LAG_TIME_DIFF" "OPLOG_MASTER_TIME" "OPLOG_RATE_GB_PER_HOUR" "OPLOG_SLAVE_LAG_MASTER_TIME" "OPLOG_REPLICATION_LAG" "PROCESS_CPU_CHILDREN_KERNEL" "PROCESS_CPU_CHILDREN_USER" "PROCESS_CPU_KERNEL" "PROCESS_CPU_USER" "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "PROCESS_NORMALIZED_CPU_CHILDREN_USER" "PROCESS_NORMALIZED_CPU_KERNEL" "PROCESS_NORMALIZED_CPU_USER" "QUERY_EXECUTOR_SCANNED" "QUERY_EXECUTOR_SCANNED_OBJECTS" "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" "QUERY_TARGETING_SCANNED_PER_RETURNED" "RESTARTS_IN_LAST_HOUR" "SWAP_USAGE_FREE" "SWAP_USAGE_USED" "SYSTEM_CPU_GUEST" "SYSTEM_CPU_IOWAIT" "SYSTEM_CPU_IRQ" "SYSTEM_CPU_KERNEL" "SYSTEM_CPU_NICE" "SYSTEM_CPU_SOFTIRQ" "SYSTEM_CPU_STEAL" "SYSTEM_CPU_USER" "SYSTEM_MEMORY_AVAILABLE" "SYSTEM_MEMORY_FREE" "SYSTEM_MEMORY_USED" "SYSTEM_NETWORK_IN" "SYSTEM_NETWORK_OUT" "SYSTEM_NORMALIZED_CPU_GUEST" "SYSTEM_NORMALIZED_CPU_IOWAIT" "SYSTEM_NORMALIZED_CPU_IRQ" "SYSTEM_NORMALIZED_CPU_KERNEL" "SYSTEM_NORMALIZED_CPU_NICE" "SYSTEM_NORMALIZED_CPU_SOFTIRQ" "SYSTEM_NORMALIZED_CPU_STEAL" "SYSTEM_NORMALIZED_CPU_USER" "TICKETS_AVAILABLE_READS" "TICKETS_AVAILABLE_WRITE" "OPERATION_THROTTLING_REJECTED_OPERATIONS" Um ou mais tipos de medição a serem solicitados para esse processo do MongoDB. Se omitido, o recurso retorna todas as medições. Para especificar valores múltiplos para `m`, repita o parâmetro `m` para cada valor. Especifique as medições que se aplicam ao host especificado. O MongoDB Cloud retornará um erro se você especificar um medição inválida.
período	string Exemplo: período=PT10H Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
granularidade necessário	string Exemplo: granularity=PT1M Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
iniciar	string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
end	string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"databaseName": "string",
"end": "2019-08-24T14:15:22Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

Baixar registro para um host de cluster em um projeto

Retorna um arquivo de arquivo de log compactado (.gz) que contém uma faixa de mensagens de log para o host especificado para o projeto especificado. O MongoDB atualiza os logs de processo e auditar da infraestrutura de backend do cluster a cada cinco minutos. Os registros são armazenados em blocos de aproximadamente cinco minutos de duração, mas essa duração pode variar. Se você pesquisar arquivos de log na API, recomendamos a sondagem a cada cinco minutos, embora as sondagens consecutivas possam conter alguns registros sobrepostos. Esse recurso não está disponível para clusters M0 gratuitos, clusters M2, M5 ou clusters sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a role Somente leitura de acesso a dados do projeto ou superior. A API API não suporta chamadas diretas com o JSON esquema de resposta JSON. Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.YYYY-MM-DD+gzip".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
hostName necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}\|([0-9a-f]{1,4}:)... Etiqueta legível por humanos que identifica o host que armazena os arquivos de log que você deseja baixar.
logName necessário	string Enum: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log" Rótulo legível por humanos que identifica o arquivo de registro que você deseja retornar. Para retornar registros de auditoria, habilite a auditoria de banco de dados para o projeto especificado. Configurar auditoria de banco de dados

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
endDate	inteiro <int64> >= 1199145600 Especifica a data e a hora do ponto final do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a UNIX epoch. Esse valor terá como padrão 24 horas após a data de início. Se a data de início também não for especificada, o valor será padronizado para a hora da solicitação.
startDate	inteiro <int64> >= 1199145600 Especifica a data e a hora do ponto de partida do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a época do UNIX. Esse valor terá como padrão 24 horas antes da data final. Se a data de término também não for especificada, o valor padrão será 24 horas antes da hora da solicitação.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

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

Clusters Multinuvem

Retorna, adiciona, edita ou remove clusters multicloud. Alterações nas configurações do cluster podem afetar os custos.

O número total de nós em clusters que abrangem regiões tem uma restrição específica por projeto. O MongoDB cloud limita o número total de nós em outras regiões em um projeto a um total de 40. Esse total exclui as regiões do Google Cloud que se comunicam entre si, clusters de nível compartilhado ou clusters sem servidor. O número total de nós entre quaisquer duas regiões deve atender a essa restrição. Por exemplo, se um projeto tiver nós em clusters espalhados por três regiões: 30 nós na região A, 10 nós na região B e 5 nós na região C, você poderá adicionar apenas mais 5 nós à região C porque, se excluir a região C , Região A + Região B = 40. Se você excluir a região B, região A + região C = 35, <= 40. Se você excluir a região A, região B + região C = 15, <= 40. Cada combinação de regiões com os 5 nós adicionados ainda atende à restrição por projeto. Região A + B = 40. Região A + C = 40. Região B + C = 20. Você não pode criar um cluster multirregional em um projeto se ele tiver um ou mais clusters abrangendo 40 ou mais nós em outras regiões. Cada projeto suporta até 25 comando de banco de dados.

Se o seu projeto do MongoDB Cloud contiver uma função personalizada que usa ações introduzidas em uma versão específica do MongoDB, você deverá excluir essa função antes de criar clusters com uma versão anterior do MongoDB. Os clusters do MongoDB cloud criados após julho de 2020 usam TLS versão 1.2 por padrão. Quando você cria um cluster, o MongoDB Cloud cria um container de rede no projeto para o fornecedor de nuvem para o qual você distribui o cluster, se ainda não existir um.

Retornar todos os clusters em um projeto

Retorna os detalhes de todos os clusters do projeto específico ao qual você tem acesso. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters multinuvem. Para usar esse recurso, a chave de API solicitante deve ter a função de somente leitura do projeto. Esta funcionalidade não está disponível para clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
includeDeletedWithRetainedBackups	booleano Padrão: false Sinalizador que indica se clusters com backups retidos devem ser retornados.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionConfigs": [{"electableSpecs": {"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
],
"totalCount": 0
}

Criar um cluster a partir de um projeto

Cria um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Este recurso pode criar clusters multinuvem. Cada projeto suporta até 25 implantações de banco de dados. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto". Esta funcionalidade não está disponível para clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cluster a ser criado no projeto específico.

acceptDataRisksAndForceReplicaSetReconfig	string <date-time> Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional, envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupções regionais. Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os documentos do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Reconfiguração de um conjunto de réplicas durante uma interrupção regional
backupEnabled	booleano Padrão: false Sinalizador que indica se o cluster pode executar backups. Se configurado para `true`, o cluster poderá executar backups. Você deve configurar esse valor para `true` para clusters NVMe. O backup usa backups em nuvem para clusters especializados e backups de cluster compartilhados para clusters inquilinos. Se configurado para `false`, o cluster não utiliza backups.
	objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. MongoDB Connector para Business Intelligence
clusterType	string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster.
configServerManagementMode	string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. Servidores de configuração de cluster fragmentado do MongoDB
diskSizeGB	número <double> [ 10 .. 4096 ] Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade. Este valor não é configurável em clusters M0/M2/M5 . O MongoDB Cloud exige este parâmetro se você definir replicationSpecs. Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco. Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado. O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.
diskWarmingMode	string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. Reduza o impacto do aquecimento do disco secundário
encryptionAtRestProvider	string Enum: "NONE" "AWS" "AZURE" "GCP" Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para garantir uma camada adicional de criptografia em repouso para o cluster. Para habilitar o gerenciamento de chaves de cliente para criptografia em repouso, a configuração do cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize deve ser `M10` ou superior e `"backupEnabled" : false` ou ser totalmente omitida. Criptografia em repouso usando o gerenciamento de chaves de cliente
globalClusterSelfManagedSharding	booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. Criando um cluster global
	Array de objetos (Etiqueta do componente) Obsoleto(a) Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos. As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Recomendamos fortemente que você use marcações de recursos.
mongoDBMajorVersion	string Versão principal do MongoDB do cluster. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. Versões do MongoDB disponíveis no Atlas
name	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível para humanos que identifica o cluster avançado.
pausado	booleano Sinalizador que indica se o cluster está pausado.
pitEnabled	booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. Backups contínuos da nuvem
replicaSetScalingStrategy	string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. Modifique o modo de dimensionamento do conjunto de réplicas
	Array de objetos (Especificações de replicação) Lista de configurações que configuram suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde os nós dos clusters são distribuídos. Para clusters fragmentados não globais e conjuntos de réplicas, essa array tem um objeto que representa onde os nós dos clusters são distribuídos.
rootCertType	string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificação raiz que o cluster do MongoDB Cloud usa. O MongoDB Cloud é compatível com oInternet Security Research Group.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Resource Tags
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como `true`, o MongoDB Cloud não excluirá o cluster. Se definido como `false`, o MongoDB Cloud excluirá o cluster.
versionReleaseSystem	string Padrão: "LTS" Enum: "LTS" "CONTINUOUS" Método pelo qual o cluster mantém as versões do MongoDB. Se o valor for `CONTINUOUS`, você não deverá especificar mongoDBMajorVersion.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Cluster multinuvem

{"clusterType": "REPLICASET",
"links": [ ],
"name": "multiCloud",
"replicationSpecs": [{"numShards": 1,
"regionConfigs": [{"analyticsAutoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"autoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"electableSpecs": {"instanceSize": "M30",
"nodeCount": 3
},
"hiddenSecondarySpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"readOnlySpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"regionName": "US_EAST_1"
},
{"analyticsAutoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"autoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"electableSpecs": {"instanceSize": "M30",
"nodeCount": 2
},
"hiddenSecondarySpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"priority": 6,
"providerName": "GCP",
"readOnlySpecs": {"instanceSize": "M30",
"nodeCount": 0
},
"regionName": "EASTERN_US"
}
],
"zoneName": "Zone 1"
}
]
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionConfigs": [{"electableSpecs": {"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Remover um cluster de um projeto

Remove um cluster do projeto especificado. A proteção do cluster contra encerramento deve estar desabilitada para que ele possa ser excluído. Para utilizar esse recurso, a API chave solicitante deve ter o role de proprietário do projeto. Essa funcionalidade não está disponível para clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
retainBackups	booleano Sinalizador que indica se deseja manter snapshots de backup para o cluster dedicado excluído.

Respostas

Exemplos de resposta

400
401
404
409
500

Tipo de conteúdo

aplicação/json

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

Retornar um cluster de um projeto

Retorna os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters multinuvem. Para usar esse recurso, a chave de API solicitante deve ter a função de somente leitura do projeto. Esta funcionalidade não está disponível para clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica este cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
409
500

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionConfigs": [{"electableSpecs": {"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Modificar um cluster de um projeto

Atualiza os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Este recurso pode atualizar clusters multinuvem. Para atualizar a proteção de encerramento de um cluster, a chave de API solicitante deve ter a função de proprietário do projeto. Para todas as outras atualizações, a chave de API solicitante deve ter a função de gerenciador de cluster de projeto. Não é possível modificar um cluster pausado (paused : true). Você deve chamar esse endpoint para definir paused : false. Depois que esse endpoint responder com paused : false, você poderá chamá-lo novamente com as alterações que deseja fazer no cluster. Esta funcionalidade não está disponível para clusters sem servidor.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cluster a ser atualizado no projeto especificado.

acceptDataRisksAndForceReplicaSetReconfig	string <date-time> Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional, envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupções regionais. Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os documentos do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Reconfiguração de um conjunto de réplicas durante uma interrupção regional
backupEnabled	booleano Padrão: false Sinalizador que indica se o cluster pode executar backups. Se configurado para `true`, o cluster poderá executar backups. Você deve configurar esse valor para `true` para clusters NVMe. O backup usa backups em nuvem para clusters especializados e backups de cluster compartilhados para clusters inquilinos. Se configurado para `false`, o cluster não utiliza backups.
	objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. MongoDB Connector para Business Intelligence
clusterType	string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster.
configServerManagementMode	string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. Servidores de configuração de cluster fragmentado do MongoDB
diskSizeGB	número <double> [ 10 .. 4096 ] Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade. Este valor não é configurável em clusters M0/M2/M5 . O MongoDB Cloud exige este parâmetro se você definir replicationSpecs. Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco. Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado. O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.
diskWarmingMode	string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. Reduza o impacto do aquecimento do disco secundário
encryptionAtRestProvider	string Enum: "NONE" "AWS" "AZURE" "GCP" Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para garantir uma camada adicional de criptografia em repouso para o cluster. Para habilitar o gerenciamento de chaves de cliente para criptografia em repouso, a configuração do cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize deve ser `M10` ou superior e `"backupEnabled" : false` ou ser totalmente omitida. Criptografia em repouso usando o gerenciamento de chaves de cliente
globalClusterSelfManagedSharding	booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. Criando um cluster global
	Array de objetos (Etiqueta do componente) Obsoleto(a) Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos. As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Recomendamos fortemente que você use marcações de recursos.
mongoDBMajorVersion	string Versão principal do MongoDB do cluster. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. Versões do MongoDB disponíveis no Atlas
name	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível para humanos que identifica o cluster avançado.
pausado	booleano Sinalizador que indica se o cluster está pausado.
pitEnabled	booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. Backups contínuos da nuvem
replicaSetScalingStrategy	string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. Modifique o modo de dimensionamento do conjunto de réplicas
	Array de objetos (Especificações de replicação) Lista de configurações que configuram suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde os nós dos clusters são distribuídos. Para clusters fragmentados não globais e conjuntos de réplicas, essa array tem um objeto que representa onde os nós dos clusters são distribuídos.
rootCertType	string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificação raiz que o cluster do MongoDB Cloud usa. O MongoDB Cloud é compatível com oInternet Security Research Group.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Resource Tags
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como `true`, o MongoDB Cloud não excluirá o cluster. Se definido como `false`, o MongoDB Cloud excluirá o cluster.
versionReleaseSystem	string Padrão: "LTS" Enum: "LTS" "CONTINUOUS" Método pelo qual o cluster mantém as versões do MongoDB. Se o valor for `CONTINUOUS`, você não deverá especificar mongoDBMajorVersion.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBMajorVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"numShards": 1,
"regionConfigs": [{"electableSpecs": {"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionConfigs": [{"electableSpecs": {"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

Testar failover para um cluster

Inicia um teste de failover para o cluster especificado no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Um teste de failover verifica como o MongoDB Cloud administra a falha do nó primário do cluster. Durante o teste, o MongoDB Cloud desliga o nó primário e elege um novo primário. Para utilizar este recurso, a chave de API solicitante deve ter a função de gerenciador de cluster de projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

401
500

Tipo de conteúdo

aplicação/json

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

Emparelhamento de rede

Retorna, adiciona, edita e remove contêineres de emparelhamento de rede e conexões de emparelhamento. Quando você implanta um cluster dedicado M10+, o Atlas cria uma VPC para o provedor selecionado e a região ou regiões se não houver nenhuma conexão de emparelhamento de VPC ou VPC para esse provedor e região. O Atlas atribui à VPC um bloco de roteamento interdomínio sem classes (CIDR).

Retornar todos os containers de emparelhamento de rede em um projeto para um provedor de nuvem

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). Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
providerName necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Fornecedor de serviços de cloud que atende aos containers de emparelhamento de rede desejados.

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "stringstringstringstringstringstringst"
}
],
"totalCount": 0
}

Criar um novo container de emparelhamento de rede

Cria um novo container de emparelhamento de rede no projeto especificado. O MongoDB Cloud pode distribuir conexões de emparelhamento de rede em um conexão de emparelhamento de rede de emparelhamento de rede. O GCP pode ter um container por projeto. AWS e Azure podem ter um container por região do fornecedor de nuvem. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria um novo container de emparelhamento de rede no projeto especificado.

providerName	string Fornecedor de serviços de nuvem que atende aos contêineres de emparelhamento de rede solicitados. AWS
atlasCidrBlock	string^((([0-9]{1,3}\.){3}[0-9]{1,3})\|(:{0,2}([0-9a... Endereços IP expressos na notação Roteamento entre domínios sem classe (CIDR) que o MongoDB Cloud usa para os containers de emparelhamento de rede em seu projeto. O MongoDB Cloud atribui a todos os clusters do projeto distribuídos nesse fornecedor de nuvem um endereço IP dessa faixa. O MongoDB Cloud bloqueia esse valor se houver um cluster M10 ou superior ou uma conexão de emparelhamento de rede nesse projeto. Esses blocos CIDR devem estar dentro dos intervalos reservados por RFC 1918. A AWS e o Azure limitam ainda mais o bloqueio entre os intervalos `/24` e `/21` . Para modificar o bloco CIDR, o projeto de destino não pode ter: Qualquer cluster M10 ou superior Quaisquer outras conexões de peering VPC Você também pode criar um novo projeto e criar uma conexão de emparelhamento de rede para definir o bloco de container CIDR de emparelhamento de rede MongoDB Cloud desejado para esse projeto. O MongoDB Cloud limita o número de nós do MongoDB por conexão de emparelhamento de rede com base no bloco CIDR e na região selecionada para o projeto. Exemplo: Um projeto em uma região da Amazon Web Services (AWS) com suporte a três zonas de disponibilidade e um bloco de containers de emparelhamento de rede CIDR do MongoDB com limite de `/24` equivale a 27 conjuntos de réplicas de três nós.
regionName necessário	string Enum: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1" Área geográfica que a Amazon Web Services (AWS) define para a qual o MongoDB Cloud distribuiu esse container de emparelhamento de rede.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"atlasCidrBlock": "string",
"region": "US_CENTRAL",
"regionName": "US_EAST_1"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "stringstringstringstringstringstringst",
"regionName": "US_EAST_1",
"vpcId": "vpc-b555d3b0d9cb783b0"
}

Retornar todos os containers de emparelhamento de rede em um projeto

Retornar detalhes sobre todos os contêineres de emparelhamento de rede no projeto especificado. Os contêineres de emparelhamento de rede contêm conexões de emparelhamento de rede. Para usar este recurso, a chave de API solicitante deve possuir a função de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "stringstringstringstringstringstringst"
}
],
"totalCount": 0
}

Remover um contêiner de emparelhamento de rede

Remove um contêiner de emparelhamento de rede no projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

containerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que você deseja remover.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{ }

Retornar um contêiner de emparelhamento de rede

Retorna detalhes sobre um container de emparelhamento de rede em um projeto especificado. Os containers de emparelhamento de rede contêm conexões de peering de rede. Para usar este recurso, a chave da API solicitante deve ter a role Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

containerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "stringstringstringstringstringstringst",
"regionName": "US_EAST_1",
"vpcId": "vpc-b555d3b0d9cb783b0"
}

Atualizar um container de emparelhamento de rede

Atualiza os detalhes de rede e etiquetas de um container de emparelhamento de rede especificado no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

containerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que você deseja remover.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza os detalhes de rede e rótulos de um contêiner de emparelhamento de rede especificado no projeto especificado.

providerName	string Fornecedor de serviços de nuvem que atende aos contêineres de emparelhamento de rede solicitados. AWS
atlasCidrBlock	string^((([0-9]{1,3}\.){3}[0-9]{1,3})\|(:{0,2}([0-9a... Endereços IP expressos na notação Roteamento entre domínios sem classe (CIDR) que o MongoDB Cloud usa para os containers de emparelhamento de rede em seu projeto. O MongoDB Cloud atribui a todos os clusters do projeto distribuídos nesse fornecedor de nuvem um endereço IP dessa faixa. O MongoDB Cloud bloqueia esse valor se houver um cluster M10 ou superior ou uma conexão de emparelhamento de rede nesse projeto. Esses blocos CIDR devem estar dentro dos intervalos reservados por RFC 1918. A AWS e o Azure limitam ainda mais o bloqueio entre os intervalos `/24` e `/21` . Para modificar o bloco CIDR, o projeto de destino não pode ter: Qualquer cluster M10 ou superior Quaisquer outras conexões de peering VPC Você também pode criar um novo projeto e criar uma conexão de emparelhamento de rede para definir o bloco de container CIDR de emparelhamento de rede MongoDB Cloud desejado para esse projeto. O MongoDB Cloud limita o número de nós do MongoDB por conexão de emparelhamento de rede com base no bloco CIDR e na região selecionada para o projeto. Exemplo: Um projeto em uma região da Amazon Web Services (AWS) com suporte a três zonas de disponibilidade e um bloco de containers de emparelhamento de rede CIDR do MongoDB com limite de `/24` equivale a 27 conjuntos de réplicas de três nós.
regionName necessário	string Enum: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1" Área geográfica que a Amazon Web Services (AWS) define para a qual o MongoDB Cloud distribuiu esse container de emparelhamento de rede.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"providerName": "AWS",
"atlasCidrBlock": "string",
"region": "US_CENTRAL",
"regionName": "US_EAST_1"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"provisioned": true,
"atlasCidrBlock": "string",
"azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
"region": "US_CENTRAL",
"vnetName": "stringstringstringstringstringstringst",
"regionName": "US_EAST_1",
"vpcId": "vpc-b555d3b0d9cb783b0"
}

Retornar todas as conexões de emparelhamento de rede em um projeto

Retorna detalhes sobre todas as conexões de emparelhamento de rede no projeto especificado. O emparelhamento de rede permite que vários aplicativos hospedados na nuvem se conectem com segurança ao mesmo projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
providerName	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem para usar nesta conexão de peering VPC.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"containerId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"accepterRegionName": "string",
"awsAccountId": "stringstring",
"connectionId": "string",
"errorStateName": "REJECTED",
"routeTableCidrBlock": "string",
"statusName": "INITIATING",
"vpcId": "string"
}
],
"totalCount": 0
}

Criar uma nova conexão de peering de rede

Cria uma nova conexão de emparelhamento de rede no projeto especificado. O emparelhamento de rede permite que vários aplicativos hospedados na nuvem se conectem com segurança ao mesmo projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto. Para saber mais sobre considerações e pré-requisitos, consulte a Documentação de emparelhamento de rede.

Pré-requisitos de emparelhamento de rede Azure

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Crie uma conexão de peering de rede.

accepterRegionName necessário	string Região do Amazon Web Services (AWS) onde fica a conexão de emparelhamento virtual (VPC) que você emparelhou com a VPC do MongoDB Cloud. O recurso retorna `null` se sua VPC e a VPC do MongoDB Cloud estiverem na mesma região.
awsAccountId necessário	string = 12 caracteres ^[0-9]{12}$ String exclusiva de 12 dígitos que identifica a conta da Amazon Web Services (AWS) que possui a VPC que você emparelhou com a VPC do MongoDB Cloud.
containerId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.
providerName	string Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada. AWS
routeTableCidrBlock necessário	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Endereços IP (Internet Protocol) expressos em notação CIDR (Classless Inter-Domain Routing) da sub-rede da VPC que você deseja emparelhar com a VPC do MongoDB Cloud.
vpcId necessário	string >= 5 caracteres ^vpc-[0-9a-f]{17}$ String única que identifica a VPC na Amazon Web Services (AWS) que você deseja emparelhar com a VPC do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"accepterRegionName": "string",
"awsAccountId": "stringstring",
"containerId": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"routeTableCidrBlock": "string",
"vpcId": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"accepterRegionName": "string",
"awsAccountId": "stringstring",
"connectionId": "string",
"containerId": "32b6e34b3d91647abb20e7b8",
"errorStateName": "REJECTED",
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"routeTableCidrBlock": "string",
"statusName": "INITIATING",
"vpcId": "string"
}

Remover uma conexão de emparelhamento de rede existente

Remove uma conexão de emparelhamento de rede no projeto especificado. Se você remover a última conexão de emparelhamento de rede associada a um projeto, o MongoDB Cloud também removerá todos os grupos de segurança da AWS da lista de acesso IP do projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

peerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica a conexão de emparelhamento de rede que você deseja excluir.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

202
404
409
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma conexão de peering de rede em um projeto

Retorna detalhes sobre uma conexão de emparelhamento de rede especificada no projeto especificado. Para usar este recurso, a chave de API solicitante deve ter a função "somente leitura" do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

peerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica a conexão de peering de rede que você deseja recuperar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"accepterRegionName": "string",
"awsAccountId": "stringstring",
"connectionId": "string",
"containerId": "32b6e34b3d91647abb20e7b8",
"errorStateName": "REJECTED",
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"routeTableCidrBlock": "string",
"statusName": "INITIATING",
"vpcId": "string"
}

Atualizar uma nova conexão de emparelhamento de rede

Atualiza uma conexão de peering de rede especificada no projeto especificado. Para usar esse recurso, a chave de API solicitada deve ter a role Proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

peerId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String única de 24 dígitos hexadecimais que identifica a conexão de emparelhamento de rede que você deseja atualizar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Modificar uma conexão de emparelhamento de rede.

accepterRegionName necessário	string Região do Amazon Web Services (AWS) onde fica a conexão de emparelhamento virtual (VPC) que você emparelhou com a VPC do MongoDB Cloud. O recurso retorna `null` se sua VPC e a VPC do MongoDB Cloud estiverem na mesma região.
awsAccountId necessário	string = 12 caracteres ^[0-9]{12}$ String exclusiva de 12 dígitos que identifica a conta da Amazon Web Services (AWS) que possui a VPC que você emparelhou com a VPC do MongoDB Cloud.
containerId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.
providerName	string Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada. AWS
routeTableCidrBlock necessário	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Endereços IP (Internet Protocol) expressos em notação CIDR (Classless Inter-Domain Routing) da sub-rede da VPC que você deseja emparelhar com a VPC do MongoDB Cloud.
vpcId necessário	string >= 5 caracteres ^vpc-[0-9a-f]{17}$ String única que identifica a VPC na Amazon Web Services (AWS) que você deseja emparelhar com a VPC do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"accepterRegionName": "string",
"awsAccountId": "stringstring",
"containerId": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"routeTableCidrBlock": "string",
"vpcId": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"accepterRegionName": "string",
"awsAccountId": "stringstring",
"connectionId": "string",
"containerId": "32b6e34b3d91647abb20e7b8",
"errorStateName": "REJECTED",
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"routeTableCidrBlock": "string",
"statusName": "INITIATING",
"vpcId": "string"
}

Verificar modo "conexão via somente emparelhamento" para um projeto Obsoleto

Verifica se alguém definiu o projeto especificado como modo Conectar via somente emparelhamento. Para usar este recurso, a chave de API solicitante deve ter a função "somente leitura" do projeto.

Alterações nas cadeias de conexão

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
404
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Desabilitar conexão somente via modo de emparelhamento para um projeto obsoleto

Desabilita o modo "Conectar via somente emparelhamento" para o projeto especificado. Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Proprietário do projeto".

Alterações nas cadeias de conexão

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Desativa o modo Connect via Peering Only para o projeto especificado.

habilitado

necessário

booleano

Sinalizador que indica se alguém habilitou o modo Conectar via somente emparelhamento para o projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Arquivo On-line

Retorna, adiciona, edita ou remove um arquivo on-line.

Retornar todos os arquivos on-line de um cluster

Retorna detalhes de todos os arquivos online. Esse arquivo armazena dados de um cluster dentro de um projeto. Para usar este recurso, a chave da API solicitante deve possuir a função de Somente Leitura do Projeto.

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica o cluster que contém a collection para a qual você deseja retornar o arquivo online.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "TIMESERIES",
"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"dataProcessRegion": {"cloudProvider": "AWS"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [{"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {"type": "DEFAULT"
},
"state": "PENDING"
}
],
"totalCount": 0
}

Criar um Online Archive

Cria um arquivo on-line. Esse arquivo armazena dados de um cluster dentro de um projeto. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso a dados do projeto".

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível para humanos que identifica o cluster que contém a collection para a qual você deseja criar um arquivo online.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria um arquivo on-line.

collName necessário	string Etiqueta legível para humanos que identifica a collection para a qual você criou o arquivo online.
collectionType	string Padrão: "standard" Enum: "TIMESERIES" "standard" Classificação da collection de banco de dados MongoDB que você deseja retornar. Se você configurar este parâmetro para `TIMESERIES`, configure `"criteria.type" : "date"` e `"criteria.dateFormat" : "ISODATE"`.
necessário	objeto (CriteriaView) Regras pelas quais o MongoDB Cloud arquiva dados. Use o campo criteria.type para escolher como o MongoDB Cloud seleciona dados para arquivar. Escolha os dados usando a idade dos dados ou uma consulta do MongoDB. "criteria.type": "DATE" seleciona documentos para arquivar com base em uma data. "criteria.type": "CUSTOM" seleciona documentos para arquivar com base em uma consulta JSON personalizada. O MongoDB Cloud não aceita "criteria.type": "CUSTOM" quando "collectionType": "TIMESERIES".
	objeto (DataExpirationRuleView) Regra para especificar quando os dados devem ser excluídos do arquivo.
	objeto (CreateDataProcessRegionView) Configurações para definir a região em que você deseja armazenar seus dados arquivados.
dbName necessário	string Etiqueta legível por humanos do banco de dados que contém a collection que contém o arquivo online.
	Array de objetos (Partição de arquivo online) non-empty Lista que contém parâmetros de documento a serem usados para dividir de forma lógica os dados em uma coleção. As partições fornecem um nível aproximado de filtragem dos dados de coleta subjacentes. Para dividir seus dados, especifique os parâmetros que você consulta com frequência. Se você especificou ":criteria.type": "DATE" no endpoint CREATE ONE ONLINE ARCHIVE, então pode especificar até três parâmetros para a consulta. Um desses parâmetros deve ser o valor DATE, que é necessário nesse caso. Se você especificou ":criteria.type": "CUSTOM" no endpoint CREATE ONE ONLINE ARCHIVE, poderá especificar até dois parâmetros para a consulta. Consultas que não usam parâmetros ":criteria.type": "DATA" ou ":criteria.type": "CUSTOM" fazem o MongoDB examinar uma coleção completa de todos os documentos arquivados. Isso leva mais tempo e aumenta seus custos.
pausado	booleano Sinalizador que indica se este arquivo online existe no estado de pausa. Uma solicitação para retomar falha se a collection tiver outro arquivo online ativo. Para pausar um arquivo online ativo ou retomar um arquivo online pausado, você deve incluir este parâmetro. Para pausar um arquivo ativo, defina para verdadeiro. Para retomar um arquivo em pausa, defina como falso.
	objeto (Agendamento de arquivo online) Frequência regular e duração quando o processo de arquivamento ocorre.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"collName": "string",
"collectionType": "TIMESERIES",
"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"dataProcessRegion": {"cloudProvider": "AWS"
},
"dbName": "string",
"partitionFields": [{"fieldName": "string",
"order": 0
}
],
"paused": true,
"schedule": {"type": "DEFAULT"
}
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "TIMESERIES",
"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"dataProcessRegion": {"cloudProvider": "AWS"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [{"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {"type": "DEFAULT"
},
"state": "PENDING"
}

Baixar registros de query do Online Archive

Baixa registros de consulta para o arquivo on-line especificado. Para usar esse recurso, a chave de API solicitante deve ter a role Somente leitura de acesso a dados do projeto ou superior. A API não suporta chamadas diretas com o esquema de resposta JSON . Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/gzip".

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster que contém a collection para a qual você deseja retornar os logs de query de um arquivo online.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
startDate	inteiro <int64> >= 1199145600 Exemplo: startDate=1636481348 Data e hora que especificam o ponto de partida para o intervalo de mensagens de registro a serem retornadas. Esse recurso expressa esse valor no número de segundos decorridos desde a UNIX epoch.
endDate	inteiro <int64> >= 1199145600 Exemplo: endDate=1636481348 Data e hora que especifica o end point para a faixa de mensagens de log a ser retornada. Esse recurso expressa esse valor no número de segundos decorridos desde a UNIX epoch.
archiveOnly	booleano Padrão: false Sinalizador que indica se o download de logs para queries é feito somente para o arquivo online ou para o arquivo online e o cluster.

Respostas

Exemplos de resposta

400
401
404
500

Tipo de conteúdo

aplicação/json

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

Remover um Online Archive

Remove um arquivo on-line. Esse arquivo armazena dados de um cluster dentro de um projeto. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso a dados do projeto".

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
archiveId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Sequência única de 24 dígitos hexadecimais que identifica o arquivo online que será excluído.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica o cluster que contém a coleção da qual você deseja remover um arquivo on-line.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um arquivo on-line

Retorna um arquivo online para um cluster. Esse arquivo armazena dados de um cluster dentro de um projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto.

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
archiveId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Sequência única de 24 dígitos hexadecimais que identifica o arquivo online que será retornado.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível para humanos que identifica o cluster que contém a collection especificada a partir da qual o aplicativo criou o arquivo online.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "TIMESERIES",
"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"dataProcessRegion": {"cloudProvider": "AWS"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [{"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {"type": "DEFAULT"
},
"state": "PENDING"
}

Atualizar um arquivo on-line

Atualiza, pausa ou retoma um arquivo on-line. Esse arquivo armazena dados de um cluster dentro de um projeto. Para usar esse recurso, a chave de API solicitante deve ter a função de "administrador de acesso a dados do projeto".

Arquivo On-line

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
archiveId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o arquivo online que será atualizado.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível para humanos que identifica o cluster que contém a collection especificada a partir da qual o aplicativo criou o arquivo online.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza, pausa ou retoma um arquivo on-line.

	objeto (CriteriaView) Regras pelas quais o MongoDB Cloud arquiva dados. Use o campo criteria.type para escolher como o MongoDB Cloud seleciona dados para arquivar. Escolha os dados usando a idade dos dados ou uma consulta do MongoDB. "criteria.type": "DATE" seleciona documentos para arquivar com base em uma data. "criteria.type": "CUSTOM" seleciona documentos para arquivar com base em uma consulta JSON personalizada. O MongoDB Cloud não aceita "criteria.type": "CUSTOM" quando "collectionType": "TIMESERIES".
	objeto (DataExpirationRuleView) Regra para especificar quando os dados devem ser excluídos do arquivo.
pausado	booleano Sinalizador que indica se este arquivo online existe no estado de pausa. Uma solicitação para retomar falha se a collection tiver outro arquivo online ativo. Para pausar um arquivo online ativo ou retomar um arquivo online pausado, você deve incluir este parâmetro. Para pausar um arquivo ativo, defina para verdadeiro. Para retomar um arquivo em pausa, defina como falso.
	objeto (Agendamento de arquivo online) Frequência regular e duração quando o processo de arquivamento ocorre.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"paused": true,
"schedule": {"type": "DEFAULT"
}
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "TIMESERIES",
"criteria": {"type": "DATE"
},
"dataExpirationRule": {"expireAfterDays": 7
},
"dataProcessRegion": {"cloudProvider": "AWS"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [{"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {"type": "DEFAULT"
},
"state": "PENDING"
}

Organizações

Retorna, adiciona e edita unidades organizacionais na Nuvem MongoDB.

Retornar todas as organizações

Retorna todas as organizações para as quais a chave de API solicitante tem acesso. Para usar este recurso, a chave de API solicitante deve ter a função de "membro da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
name	string Rótulo legível por humanos da organização a ser usado para filtrar a lista retornada. Executa uma pesquisa sem diferenciação de maiúsculas e minúsculas para uma organização que começa com o nome especificado.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "32b6e34b3d91647abb20e7b8",
"isDeleted": true,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}
],
"totalCount": 0
}

Criar uma organização

Cria uma organização no MongoDB Cloud e a vincula à organização da chave de API solicitante. Para usar esse recurso, a chave API solicitada deve ter a função Proprietário da organização. A organização da API Key solicitante deve ser uma organização pagante. Para saber mais, consulte Configurar uma Organização de Pagamento na documentação do Atlas MongoDB.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Organização que você deseja criar.

	objeto (CreateAtlasOrganizationApiKey) Detalhes da chave de API programática a ser criada.
federationSettingsId	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a federação à qual vincular a organização recém-criada. Se especificado, o proprietário da organização proposto da nova organização deve ter a role de proprietário da organização em uma organização associada à federação.
name necessário	string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$ Etiqueta legível para humanos que identifica a organização.
orgOwnerId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud ao qual você deseja atribuir a função "Proprietário da organização". Esse usuário deve ser um membro da mesma organização que a chave de API de chamada. Se você fornecer `federationSettingsId`, esse usuário deverá ter a função "Proprietário da organização" em uma organização na federação especificada. Esse parâmetro é necessário somente quando você se autentica com chaves de API programáticas.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"apiKey": {"desc": "string",
"roles": ["ORG_OWNER"
]
},
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"name": "string",
"orgOwnerId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"apiKey": {"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
},
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"orgOwnerId": "32b6e34b3d91647abb20e7b8",
"organization": {"id": "32b6e34b3d91647abb20e7b8",
"isDeleted": true,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}
}

Remover uma organização

Remove uma organização especificada. O MongoDB Cloud impõe os seguintes limites a esse recurso:

As organizações com projetos ativos não podem ser removidas.
Todos os projetos na organização devem ser removidos antes que você possa remover a organização. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{ }

Retornar uma organização

Retorna uma organização à qual a chave de API solicitante tem acesso. Para usar este recurso, a chave de API solicitante deve ter a função de "membro da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"isDeleted": true,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}

Renomear uma organização

Renomeia uma organização. Para usar esse recurso, a chave API solicitada deve ter a role Proprietário da organização.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes para atualizar na organização especificada.

name

necessário

string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Etiqueta legível para humanos que identifica a organização.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"isDeleted": true,
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}

Retornar um ou mais projetos de uma organização

Retorna vários projetos na organização especificada. Cada organização pode ter vários projetos. Usar projetos para:

Isole ambientes diferentes, como ambientes de desenvolvimento, teste ou produção, uns dos outros.
Associe diferentes usuários ou equipes do MongoDB Cloud a ambientes diversos ou dê permissão diferente aos usuários do MongoDB Cloud em ambientes variados.
Mantenha configurações de segurança de cluster separadas.
Crie configurações de alerta diferentes.

Para usar este recurso, a chave API solicitante deve ter a função "Membro da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
name	string Etiqueta legível por humanos do projeto a ser usado para filtrar a lista retornada. Executa uma pesquisa sem distinção entre maiúsculas e minúsculas para um projeto dentro da organização que é prefixado pelo nome especificado.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}
],
"totalCount": 0
}

Retornar todos os convites da organização

Retorna todos os convites pendentes para a organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
nome de usuário	string <email> Endereço de e-mail da conta de usuário convidada para esta organização. Se você excluir este parâmetro, o recurso retornará todos os convites pendentes.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

[{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_CLUSTER_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}
]

Atualizar convite de uma organização

Atualiza os detalhes de um convite pendente para a organização especificada. Para especificar qual convite, forneça o nome de usuário do usuário convidado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza os detalhes de um convite pendente para a organização especificada.

	Array de objetos (OrganizationInvitationGroupRoleAssignmentsRequest) Lista de projetos aos quais o usuário será adicionado quando aceitar o convite para a organização.
roles	Array de strings unique Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" Uma ou mais funções no nível da organização a serem atribuídas ao usuário do MongoDB Cloud.
teamIds	Array de strings unique [ itens = 24 caracteres ^([a-f0-9]{24})$ ] Lista de equipes para as quais você deseja convidar o usuário desejado da MongoDB Cloud.
nome de usuário	string <email> Endereço de e-mail que pertence ao usuário desejado do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"roles": ["GROUP_CLUSTER_MANAGER"
]
}
],
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_CLUSTER_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Convidar um usuário do MongoDB Cloud para participar de uma organização Atlas

Convida um usuário do MongoDB Cloud para participar da organização especificada. O usuário deve aceitar o convite para acessar informações dentro da organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Convida um usuário do MongoDB Cloud para participar da organização especificada.

	Array de objetos (OrganizationInvitationGroupRoleAssignmentsRequest) Lista de projetos aos quais o usuário será adicionado quando aceitar o convite para a organização.
roles	Array de strings unique Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" Uma ou mais funções no nível da organização a serem atribuídas ao usuário do MongoDB Cloud.
teamIds	Array de strings unique [ itens = 24 caracteres ^([a-f0-9]{24})$ ] Lista de equipes para as quais você deseja convidar o usuário desejado da MongoDB Cloud.
nome de usuário	string <email> Endereço de e-mail que pertence ao usuário desejado do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"roles": ["GROUP_CLUSTER_MANAGER"
]
}
],
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_CLUSTER_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Cancelar o convite de uma organização

Cancela um convite pendente enviado ao usuário específico da MongoDB Cloud para participar de uma organização. Você não pode cancelar um convite que o usuário aceitou. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
invitationId necessário	string String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Devolver o convite de uma organização

Retorna os detalhes de um convite pendente para a organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
invitationId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_CLUSTER_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Atualizar um convite de uma organização por ID de convite

Atualiza os detalhes de um convite pendente para a organização especificada. Para especificar qual convite, forneça a string de identificação única para este convite. Use o ponto de extremidade "Retornar todos os convites da organização" para recuperar IDs de todos os convites de organização pendentes. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
invitationId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza os detalhes de um convite pendente para a organização especificada.

	Array de objetos (OrganizationInvitationGroupRoleAssignmentsRequest) Lista de projetos aos quais o usuário será adicionado quando aceitar o convite para a organização.
roles	Array de strings unique Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" Uma ou mais funções no nível da organização a serem atribuídas ao usuário do MongoDB Cloud.
teamIds	Array de strings unique [ itens = 24 caracteres ^([a-f0-9]{24})$ ] Lista de equipes para as quais você deseja convidar o usuário desejado da MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"roles": ["GROUP_CLUSTER_MANAGER"
]
}
],
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupRoleAssignments": [{"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_CLUSTER_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": ["ORG_OWNER"
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}

Retornar configurações de uma organização

Retorna detalhes sobre as configurações da organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
403
404
500

Tipo de conteúdo

aplicação/json

{"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 0,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string"
}

Atualizar configurações de uma organização

Atualiza as configurações da organização. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes para atualizar as configurações da organização especificada.

apiAccessListRequired	booleano Sinalizador que indica se é necessário que as operações da API se originem de um endereço IP adicionado à lista de acesso à API para a organização especificada.
genAIFeaturesEnabled	booleano Padrão: true Sinalizador que indica se esta organização tem acesso a AI recursos IA generativa . Esta configuração só se aplica ao Atlas Commercial e está habilitada por padrão. Depois que essa configuração estiver ativada, os proprietários do projeto poderão ativar ou desativar AI recursos individuais de IA no nível do projeto . Perguntas frequentes sobre IA generativa
maxServiceAccountSecretValidityInHours	inteiro <int32> Número que representa o período máximo antes da expiração em horas para novos segredos de conta do Atlas Admin API Service na organização especificada .
multiFactorAuthRequired	booleano Sinalizador que indica se é necessário que os usuários definam a Autenticação Multifator (MFA) antes de acessar a organização especificada. Para saber mais, consulte: https://www.mongodb.com/pt-br/docs/atlas/security-multi-factor-authentication/.
restringirEmployeeAccess	booleano Sinalizador que indica se o suporte do MongoDB deve ter o aceso bloqueado à infraestrutura e aos logs de cluster do Atlas para qualquer implantação na organização especificada sem permissão explícita. Depois que essa configuração estiver ativada, você poderá conceder ao Suporte do MongoDB um acesso alternativo de 24 horas à implantação do Atlas para resolver problemas de suporte. Para saber mais, consulte: https://www.mongodb.com/pt-br/docs/atlas/security-restrict-support-access/.
securityContact	string string string que especifica um único endereço de e-mail para a organização especificada receber notificações relacionadas à segurança. A especificação de um contato de segurança não concede a ele autorização ou acesso ao Atlas para decisões ou aprovações de segurança. Uma string vazia é válida e limpa o contato de segurança existente (se houver).

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 0,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"apiAccessListRequired": true,
"genAIFeaturesEnabled": true,
"maxServiceAccountSecretValidityInHours": 0,
"multiFactorAuthRequired": true,
"restrictEmployeeAccess": true,
"securityContact": "string"
}

Retornar todos os usuários da nuvem MongoDB em uma organização

Retorna detalhes sobre os usuários do MongoDB Cloud associados à organização especificada. Cada usuário do MongoDB Cloud retornado deve pertencer à organização especificada ou a um projeto dentro da organização especificada. Para usar este recurso, a chave API solicitante deve ter a função "Membro da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}
],
"totalCount": 0
}

Remover um usuário do MongoDB Cloud de uma organização

Remove um usuário do MongoDB Cloud da organização especificada. Para usar esse recurso, a chave de API solicitante deve ter a função "Administrador de usuários da organização".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
ID do usuário necessário	string = 24 caracteres ^([a-f0-9]{24})$ string exclusiva de 24 dígitos hexadecimais que identifica o usuário a ser excluído.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{ }

Assistente de desempenho

Retorna índices sugeridos e dados de consulta lentos para uma implantação de banco de dados. Também ativa ou desativa os limites de operação lenta gerenciados pela nuvem do MongoDB. Para visualizar os valores de campo em uma consulta de amostra, você deve ter a função "Somente leitura de acesso aos dados" do projeto ou superior. Caso contrário, o MongoDB Cloud retornará dados editados em vez dos valores dos campos.

Desabilitar limite de operação lenta gerenciada

Desabilita o limite de operação lento que o MongoDB Cloud calculou para o projeto especificado. O limite determina quais operações o Performance Advisor e o Profiler de query consideram lentas. Quando ativado, o MongoDB Cloud usa o tempo médio de execução das operações em seu cluster para determinar as consultas de execução lenta. Como resultado, o limite é mais pertinente ao volume de trabalho do cluster. O limite de operação lenta é habilitado por padrão para clusters dedicados (M10+). Quando desabilitado, o MongoDB Cloud considera lenta qualquer operação que demore mais de 100 milissegundos. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

401
403
500

Tipo de conteúdo

aplicação/json

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

Ativar o limite de operação lenta gerenciada

Permite que o MongoDB Cloud use seu limite de operação lenta para o projeto especificado. O limite determina quais operações o Performance Advisor e o Profiler de query consideram lentas. Quando ativado, o MongoDB Cloud usa o tempo médio de execução das operações em seu cluster para determinar as consultas de execução lenta. Como resultado, o limite é mais pertinente ao volume de trabalho do cluster. O limite de operação lenta é habilitado por padrão para clusters dedicados (M10+). Quando desabilitado, o MongoDB Cloud considera lenta qualquer operação que demore mais de 100 milissegundos. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

401
403
500

Tipo de conteúdo

aplicação/json

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

Retornar todos os namespaces de um host

Retorna até 20 namespaces para coleções com consultas lentas no host especificado. Se você especificar um nó secundário de um conjunto de réplicas que não recebeu nenhuma operação de leitura do banco de dados, o ponto de extremidade não retornará nenhum namespace. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combinação de host e porta que atende ao processo do MongoDB. O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo MongoDB escuta solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
duration	inteiro <int64> Duração do tempo expresso durante o qual a consulta encontra índices sugeridos entre os namespaces gerenciados no cluster. Este parâmetro expressa seu valor em milissegundos. Se você não especificar o parâmetro since, o ponto de extremidade retornará os dados cobrindo a duração antes do tempo atual. Se você não especificar nem os parâmetros duration nem since, o ponto de extremidade retornará dados das 24 horas anteriores.
desde	inteiro <int64> >= 1199145600000 Data e hora a partir das quais a query recupera os índices sugeridos. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX. Se você não especificar o parâmetro duration , o ponto de extremidade retornará os dados que abrangem o valor since e a hora atual. Se você não especificar os parâmetros duration e since, o ponto de extremidade retornará dados das 24 horas anteriores.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"namespaces": [{"namespace": "string",
"type": "collection"
}
]
}

Retornar queries lentas

Retorna linhas de log para consultas lentas que o Performance Advisor e o Profiler de query identificaram. O Performance Advisor monitora as consultas que o MongoDB considera lentas e sugere novos índices para melhorar o desempenho das consultas. O MongoDB Cloud baseia o limite para consultas lentas no tempo médio das operações em seu cluster. Isso permite recomendações relevantes para o volume de trabalho. Para usar este recurso, a chave API solicitada deve ter a função de leitura e gravação do projeto de acesso aos dados.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combinação de host e porta que atende ao processo do MongoDB. O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo MongoDB escuta solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
duration	inteiro <int64> Duração do tempo expresso durante o qual a consulta encontra consultas lentas entre os namespaces gerenciados no cluster. Este parâmetro expressa seu valor em milissegundos. Se você não especificar o parâmetro since, o ponto de extremidade retornará os dados cobrindo a duração antes do tempo atual. Se você não especificar nem os parâmetros duration nem since, o ponto de extremidade retornará dados das 24 horas anteriores.
namespaces	Array de strings Namespaces dos quais recuperar consultas lentas. Um namespace consiste em um banco de dados e um recurso de coleção escrito como `.`: `<database>.<collection>`. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um ampersand (`&`) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces.
nLogs	inteiro <int64> [ 0 .. 20000 ] Padrão: 20000 Número máximo de linhas do registro a serem retornadas.
desde	inteiro <int64> >= 1199145600000 Data e hora a partir das quais a query recupera as queries lentas. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX. Se você não especificar o parâmetro duration , o ponto de extremidade retornará os dados que abrangem o valor since e a hora atual. Se você não especificar os parâmetros duration e since, o ponto de extremidade retornará dados das 24 horas anteriores.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"slowQueries": [{"line": "string",
"namespace": "string"
}
]
}

Retornar índices sugeridos

Retorna os índices sugeridos pelo Performance Advisor. O Performance Advisor monitora as consultas que o MongoDB considera lentas e sugere novos índices para melhorar o desempenho das consultas. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

processId

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combinação de host e porta que atende ao processo do MongoDB. O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo MongoDB escuta solicitações.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
duration	inteiro <int64> Duração do tempo expresso durante o qual a consulta encontra índices sugeridos entre os namespaces gerenciados no cluster. Este parâmetro expressa seu valor em milissegundos. Se você não especificar o parâmetro since, o ponto de extremidade retornará os dados cobrindo a duração antes do tempo atual. Se você não especificar nem os parâmetros duration nem since, o ponto de extremidade retornará dados das 24 horas anteriores.
namespaces	Array de strings Namespaces dos quais recuperar índices sugeridos. Um namespace consiste em um banco de dados e um recurso de coleção escrito como `.`: `<database>.<collection>`. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um ampersand (`&`) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces.
nExamples	inteiro <int64> Padrão: 5 Número máximo de exemplos de consultas que se beneficiam do índice sugerido.
nIndexes	inteiro <int64> Número que indica os índices máximos a sugerir.
desde	inteiro <int64> >= 1199145600000 Data e hora a partir das quais a query recupera os índices sugeridos. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX. Se você não especificar o parâmetro duration , o ponto de extremidade retornará os dados que abrangem o valor since e a hora atual. Se você não especificar os parâmetros duration e since, o ponto de extremidade retornará dados das 24 horas anteriores.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"shapes": [{"avgMs": 0,
"count": 0,
"id": "stringstringstringstring",
"inefficiencyScore": 0,
"namespace": "string",
"operations": [{"predicates": [{ }
],
"stats": {"ms": 0,
"nReturned": 0,
"nScanned": 0,
"ts": 0
}
}
]
}
],
"suggestedIndexes": [{"avgObjSize": 0,
"id": "stringstringstringstring",
"impact": ["stringstringstringstring"
],
"index": [{"property1": 1,
"property2": 1
}
],
"namespace": "string",
"weight": 0
}
]
}

Serviços de endpoints privados

Retorna, adiciona, edita e remove serviços de ponto de extremidade privado.

Criar um serviço de endpoint privado para um fornecedor

Crie um serviço de ponto de extremidade privado para o provedor de serviços de nuvem especificado. Esse provedor de serviços em nuvem gerencia o serviço de ponto de extremidade privado do projeto. Quando você cria um serviço de ponto de extremidade privado, o MongoDB Cloud cria um contêiner de rede no projeto para o fornecedor de serviços em nuvem para o qual você cria o serviço de ponto de extremidade privado, se ainda não existir um. Para saber mais sobre a terminologia de ponto de extremidade privado no MongoDB Cloud, consulte Conceitos de ponto de extremidade privado. Para utilizar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Conceitos de endpoints privados

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Crie um ponto de extremidade privado para o provedor de serviços de nuvem especificado.

providerName necessário	string Enum: "AWS" "AZURE" "GCP" Etiqueta legível por humanos que identifica o provedor de serviços de nuvem para o qual você deseja criar o serviço de ponto de extremidade privado.
região necessário	string Região do provedor de serviços de nuvem na qual você deseja criar o serviço ponto de extremidade privado. As regiões aceitas como valores diferem para Amazon Web Services, Google Cloud Platform e Microsoft Azure.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"providerName": "AWS",
"region": "string"
}

Exemplos de resposta

200
400
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"cloudProvider": "AWS",
"endpointServiceName": "string",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"interfaceEndpoints": ["32b6e34b3d91647abb20e7b8"
],
"regionName": "string",
"status": "INITIATING"
}

Retornar status de endpoint privado regionalizado

Verifica se cada região no provedor de serviços de nuvem especificado pode criar vários pontos de extremidade privados por região. O provedor de serviços em nuvem gerencia o ponto de extremidade privado do projeto. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
403
404
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Alternar status de endpoint privado regionalizado

Habilite ou desabilite a capacidade de criar vários pontos de extremidade privados por região em todos os fornecedores de serviços de nuvem em um projeto. O provedor de serviços em nuvem gerencia os pontos de extremidade privados do projeto. As cadeias de conexão com clusters fragmentados globais e multirregionais existentes são alteradas quando você habilita essa configuração. Atualize seus aplicativos para usar as novas cadeias de conexão. Isso pode causar tempo de inatividade. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto", e todos os clusters na implantação devem ser clusters fragmentados. Depois de habilitado, você não pode criar conjuntos de réplicas.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Habilite ou desabilite a capacidade de criar vários pontos de extremidade privados por região em todos os fornecedores de serviços de nuvem em um projeto.

habilitado

necessário

booleano

Sinalizador que indica se alguém habilitou a configuração de ponto de extremidade privado regionalizado para o projeto especificado.

Configure este valor para true para habilitar pontos de extremidade privados regionalizados. Isso permite criar mais de um ponto de extremidade privado em uma região de provedor de nuvem. Você precisa habilitar essa configuração para se conectar a clusters fragmentados globais e multirregionais do MongoDB Cloud. Habilitar pontos de extremidade privados regionalizados introduz as seguintes limitações:
- Seus aplicativos devem usar as novas cadeias de conexão para clusters fragmentados globais e multirregionais existentes. Isso pode causar tempo de inatividade.
- Seu projeto MongoDB Cloud não pode conter conjuntos de réplicas nem você pode criar novos conjuntos de réplicas neste projeto.
- Não é possível desativar essa configuração se você tiver:
  - mais de um ponto de extremidade privado em mais de uma região
  - mais de um ponto de extremidade privado em uma região e um ponto de extremidade privado em uma ou mais regiões.
Configure este valor como false para desabilitar pontos de extremidade privados regionalizados.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Exemplos de resposta

200
404
409
500

Tipo de conteúdo

aplicação/json

{"enabled": true
}

Retornar todos os serviços de endpoint privado para um fornecedor

Retorna o nome, as interfaces e o estado de todos os serviços de ponto de extremidade privado para o provedor de serviços de nuvem especificado. Esse provedor de serviços em nuvem gerencia o serviço de ponto de extremidade privado do projeto. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

cloudProvider

necessário

string

Padrão: "AWS"

Enum: "AWS" "AZURE" "GCP"

Provedor de serviços de nuvem que gerencia esse serviço de ponto de extremidade privado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
500

Tipo de conteúdo

aplicação/json

[{"cloudProvider": "AWS",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "string",
"status": "INITIATING"
}
]

Remover um serviço de endpoint privado para um fornecedor

Remove um serviço de ponto de extremidade privado do projeto especificado. Esse provedor de serviços de nuvem gerencia o serviço de pontos de extremidade privados que pertence ao projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem que gerencia esse serviço de ponto de extremidade privado.
endpointServiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado que você deseja excluir.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um serviço de endpoint privado para um fornecedor

Retorna o nome, as interfaces e o estado do serviço de ponto de extremidade privado especificado de um projeto. O provedor de serviços de nuvem hospedou esse serviço de ponto de extremidade privado que pertence ao projeto. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem que gerencia esse serviço de ponto de extremidade privado.
endpointServiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ string exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado que você deseja retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"cloudProvider": "AWS",
"endpointServiceName": "string",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"interfaceEndpoints": ["32b6e34b3d91647abb20e7b8"
],
"regionName": "string",
"status": "INITIATING"
}

Criar um endpoint privado para um fornecedor

Crie um ponto de extremidade privado para o provedor de serviços de nuvem especificado. Esse provedor de serviços em nuvem gerencia o serviço de ponto de extremidade privado, que, por sua vez, gerencia os ponto de extremidades privados do projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto". Para saber mais sobre considerações, limitações e pré-requisitos, consulte a documentação do MongoDB para configurar um ponto de extremidade privado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem que gerencia esse ponto de extremidade privado.
endpointServiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado para o qual você deseja criar um ponto de extremidade privado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Crie um ponto de extremidade privado para o provedor de serviços de nuvem especificado.

Um dos

objeto AWS Recursivo

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"id": "vpce-3bf78b0ddee411ba1"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"cloudProvider": "AWS",
"connectionStatus": "PENDING_ACCEPTANCE",
"deleteRequested": true,
"errorMessage": "string",
"interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

Remover um endpoint privado para um fornecedor

Remove um ponto de extremidade privado do projeto especificado e do serviço de ponto de extremidades privados, conforme gerenciado pelo provedor de serviços de nuvem especificado. Quando o último ponto de extremidade privado é removido de um determinado serviço de ponto de extremidade privado, esse serviço de ponto de extremidade privado também é removido. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem que gerencia esse ponto de extremidade privado.
endpointId necessário	string^vpce-[0-9a-f]{17}\|^%2[fF]subscriptions%2[fF]... string exclusiva que identifica o ponto de extremidade privado que você deseja excluir. O formato do parâmetro endpointId difere para AWS e Azure. Você deve codificar o endpointId para pontos de extremidade privados do Azure.
endpointServiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado do qual você deseja excluir um ponto de extremidade privado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um endpoint privado para um fornecedor

Retorna o estado da conexão do ponto de extremidade privado especificado. O serviço de ponto de extremidade privado gerencia esse ponto de extremidade privado que pertence a um projeto hospedado por um provedor de serviços em nuvem. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
cloudProvider necessário	string Padrão: "AWS" Enum: "AWS" "AZURE" "GCP" Provedor de serviços de nuvem que gerencia esse ponto de extremidade privado.
endpointId necessário	string^vpce-[0-9a-f]{17}\|^%2[fF]subscriptions%2[fF]... String exclusiva que identifica o ponto de extremidade privado que você deseja retornar. O formato do parâmetro endpointId difere para AWS e Azure. Você deve codificar o endpointId para pontos de extremidade privados do Azure.
endpointServiceId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado para o qual você deseja retornar um ponto de extremidade privado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"cloudProvider": "AWS",
"connectionStatus": "PENDING_ACCEPTANCE",
"deleteRequested": true,
"errorMessage": "string",
"interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

Chaves de API programáticas

Retorna, adiciona, edita e remove tokens de acesso para usar a API do MongoDB Cloud. O MongoDB Cloud aplica essas chaves às organizações. Esses recursos podem retornar, atribuir ou revogar o uso dessas chaves dentro de um projeto específico.

Retornar todas as chaves de API da organização atribuídas a um projeto

Retorna todas as chaves de API da organização que você atribuiu ao projeto especificado. Os usuários com a função "Proprietário do projeto" no projeto associado à chave de API podem usar a chave de API da organização para acessar os recursos. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}
],
"totalCount": 0
}

Criar e atribuir uma chave de API da organização a um projeto

Cria e atribui a chave de API da organização especificada ao projeto especificado. Os usuários com a função "Proprietário do projeto" no projeto associado à chave de API podem usar a chave de API da organização para acessar os recursos. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Chave API da organização a ser criada e atribuída ao projeto especificado.

desc

necessário

string [ 1 ... 250 ] caracteres

Propósito ou explicação fornecida quando alguém criou essa chave API do projeto.

roles

necessário

Array de strings non-empty

Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

Lista de funções para conceder esta chave API. Se você fornecer essa lista, forneça no mínimo um função e verifique se cada função se aplica a esse projeto.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"desc": "string",
"roles": ["ORG_OWNER"
]
}

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}

Cancelar a atribuição de uma chave de API da organização a um projeto

Remove uma chave API da organização do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

apiUserId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica esta chave de API da organização que você deseja remover de um projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
500

Tipo de conteúdo

aplicação/json

{ }

Atualizar funções de uma chave de API da organização para um projeto

Atualiza as funções da chave API da organização que você especifica para o projeto que você especifica. Você deve especificar pelo menos uma função válida para o projeto. O aplicativo remove todos as funções que você não incluir nessa solicitação se eles tiverem sido definidos anteriormente na chave da API da organização que você especificar para o projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

apiUserId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica esta chave de API da organização que você deseja remover de um projeto.

parâmetros de query

pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
envelope	booleano Padrão: false Exemplo: envelope=false 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.

Esquema do corpo da solicitação: application/json

Chave API da organização a ser atualizada. Esta solicitação exige no mínimo um dos dois parâmetros do corpo.

desc

string [ 1 ... 250 ] caracteres

Finalidade ou explicação fornecida quando alguém cria esta chave de API do projeto.

roles

Array de strings

Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

Lista de funções para conceder esta chave API. Se você fornecer essa lista, forneça no mínimo um função e verifique se cada função se aplica a esse projeto.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"desc": "string",
"roles": ["ORG_OWNER"
]
}

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}

Atribuir uma chave de API da organização a um projeto

Atribui a chave de API da organização especificada ao projeto especificado. Os usuários com a função "Proprietário do projeto" no projeto associado à chave de API podem usar a chave de API da organização para acessar os recursos. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

apiUserId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica essa chave API da organização que você deseja atribuir a um projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Chave da API da organização a ser atribuída ao projeto especificado.

Array

roles

Array de strings

Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER" "GROUP_OWNER" "GROUP_READ_ONLY"

Lista de funções para conceder esta chave API. Se você fornecer essa lista, forneça no mínimo um função e verifique se cada função se aplica a esse projeto.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"roles": ["GROUP_CLUSTER_MANAGER"
]
}
]

Exemplos de resposta

204
401
500

Tipo de conteúdo

aplicação/json

{ }

Retornar todas as chaves de API da organização

Retorna todas as chaves API da organização para a organização especificada. As chaves de API da organização concedem acesso programático a uma organização. Você não pode usar a chave de API para fazer login no MongoDB diretamente pelo console. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}
],
"totalCount": 0
}

Criar uma chave API da organização

Cria uma chave de API para a organização especificada. Uma chave de API da organização concede acesso programático a uma organização. Você não pode usar a chave de API para fazer login no console. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Chave de API da organização a ser criada.

desc necessário	string [ 1 ... 250 ] caracteres Finalidade ou explicação fornecida quando alguém criou esta chave de API da organização.
roles necessário	Array de strings non-empty Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" Lista de funções para conceder esta chave API. Se você fornecer esta lista, forneça no mínimo uma função e garanta que cada função se aplique a esta organização.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"desc": "string",
"roles": ["ORG_OWNER"
]
}

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}

Remover uma chave de API da organização

Remove uma chave de API da organização da organização especificada. Quando você remove uma chave de API de uma organização, o MongoDB Cloud também a remove de todos os projetos que a utilizam. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Configurar o acesso à API Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica esta chave API da organização.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
401
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma chave de API da organização

Retorna uma chave de API da organização. As chaves de API da organização concedem acesso programático a uma organização. Você não pode usar a chave API para fazer login na MongoDB Cloud por meio da interface do usuário. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica esta chave de API da organização que você deseja atualizar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}

Atualizar uma chave de API da organização

Atualiza uma chave de API da organização na organização especificada. As chaves de API da organização concedem acesso programático a uma organização. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica esta chave de API da organização que você deseja atualizar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Chave de API da organização a ser atualizada. Esta solicitação exige no mínimo um dos dois parâmetros do corpo.

desc	string [ 1 ... 250 ] caracteres Finalidade ou explicação fornecida quando alguém criou esta chave de API da organização.
roles	Array de strings Itens Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" Lista de funções para conceder esta chave API. Se você fornecer esta lista, forneça no mínimo uma função e garanta que cada função se aplique a esta organização.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"desc": "string",
"roles": ["ORG_OWNER"
]
}

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"desc": "string",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
"publicKey": "zmmrboas",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
}

Retornar todas as entradas da lista de acesso para uma chave de API da organização

Retorna todas as entradas da lista de acesso que você configurou para a chave de API da organização especificada. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Chaves de API programáticas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a chave de API da organização para a qual você deseja retornar entradas da lista de acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cidrBlock": "203.0.113.0/24",
"count": 1,
"created": "2019-08-24T14:15:22Z",
"ipAddress": "203.0.113.10",
"lastUsed": "2019-08-24T14:15:22Z",
"lastUsedAddress": "203.0.113.10",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Criar entradas da lista de acesso para uma chave de API da organização

Cria as entradas da lista de acesso para a chave de API da organização especificada. Os recursos exigem que todas as solicitações de API sejam originadas dos endereços IP na lista de acesso à API. Para usar esse recurso, a chave de API solicitante deve ter a função "Leitura e gravação".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica essa chave API da organização para a qual você deseja criar uma nova entrada da lista de acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Esquema do corpo da solicitação: application/json

As entradas da lista de acesso a serem criadas para a chave API da organização especificada.

Array

cidrBlock	string^((([0-9]{1,3}\.){3}[0-9]{1,3})\|(:{0,2}([0-9a... Faixa de endereços de rede que você deseja adicionar à lista de acesso da chave de API. Esse parâmetro requer que o intervalo seja expresso em notação CIDR (roteamento entre domínios) sem classe de endereços do IPv4 ou IPv6. Você pode definir um valor para esse parâmetro ou ipAddress, mas não ambos na mesma solicitação.
ipAddress	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Endereço de rede que você deseja adicionar à lista de acesso para a chave API. Esse parâmetro requer que o endereço seja expresso como um endereço do protocolo Internet versão 4 ou versão 6. Você pode definir um valor para esse parâmetro ou cidrBlock, mas não ambos na mesma solicitação.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"cidrBlock": "203.0.113.0/24",
"ipAddress": "203.0.113.10"
}
]

Exemplos de resposta

200
400
401
409
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cidrBlock": "203.0.113.0/24",
"count": 1,
"created": "2019-08-24T14:15:22Z",
"ipAddress": "203.0.113.10",
"lastUsed": "2019-08-24T14:15:22Z",
"lastUsedAddress": "203.0.113.10",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Remover uma entrada da lista de acesso para uma chave de API da organização

Remove a entrada da lista de acesso especificada da chave API da organização especificada. Os recursos exigem todas as solicitações de API provenientes dos endereços IP na lista de acesso à API. Para usar esse recurso, a chave de API solicitante deve ter a função "Leitura e gravação". Além disso, você não pode remover o endereço IP solicitado da chave API da organização solicitante.

Configurar o acesso à API Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica essa chave API da organização para a qual você deseja remover entradas de lista de acesso.
ipAddress necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}... Exemplo: 192.0.2.0%2F24 Um endereço IP ou vários endereços IP representados como um bloco CIDR para limitar as solicitações aos recursos da API na organização especificada. Ao adicionar um bloco CIDR com uma máscara de sub-rede, como 192.0.2.0/24, use o valor codificado por URL %2F para a barra /.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma entrada da lista de acesso para uma chave de API da organização

Retorna uma entrada de lista de acesso para a chave de API da organização especificada. Os recursos exigem que todas as solicitações de API sejam originadas dos endereços IP na lista de acesso à API. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Configurar o acesso à API Atlas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
ipAddress necessário	string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}... Exemplo: 192.0.2.0%2F24 Um endereço IP ou vários endereços IP representados como um bloco CIDR para limitar as solicitações aos recursos da API na organização especificada. Ao adicionar um bloco CIDR com uma máscara de sub-rede, como 192.0.2.0/24, use o valor codificado por URL %2F para a barra /.
apiUserId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a chave de API da organização para a qual você deseja retornar entradas da lista de acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"cidrBlock": "203.0.113.0/24",
"count": 1,
"created": "2019-08-24T14:15:22Z",
"ipAddress": "203.0.113.10",
"lastUsed": "2019-08-24T14:15:22Z",
"lastUsedAddress": "203.0.113.10",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Lista de acesso IP do projeto

Retorna, adiciona, edita e remove os limites de acesso à rede para implantações de banco de dados no Atlas. Este recurso substitui o recurso da lista de permissões. O Atlas removeu listas de permissões em julho de 2021. Atualize seus aplicativos para usar este novo recurso. Este recurso gerencia a lista de acesso IP de um projeto e oferece suporte à criação de entradas temporárias da lista de acesso que expiram automaticamente dentro de um período de 7 dias configurável pelo usuário.

Retornar lista de acesso IP do projeto

Retorna todas as entradas de lista de acesso da lista de acesso IP do projeto especificado. Cada entrada na lista de acesso IP do projeto contém um endereço IP ou um bloco de endereços IP com notação CIDR. O MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Para usar esse recurso, a chave de API solicitante deve ter as funções Somente leitura do projeto ou Administrador de gráficos do projeto. Este recurso substitui o recurso da lista de permissões. O MongoDB Cloud removeu as listas de permissões em julho de 2021. Atualize seus aplicativos para usar este novo recurso. O ponto de extremidade /groups/{GROUP-ID}/accessList gerencia a lista de acesso IP do banco de dados. Este ponto de extremidade é diferente do ponto de extremidade orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist, que gerencia a lista de acesso para organizações do MongoDB Cloud.

Lista de acesso IP

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"ipAddress": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Adicionar entradas à lista de acesso IP do projeto

Adiciona uma ou mais entradas de lista de acesso ao projeto especificado. O MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Grave cada entrada como um endereço IP ou um bloco de endereços IP anotado em CIDR. Para usar esse recurso, a chave API solicitante deve ter as funções de Proprietário do projeto ou Administrador de gráficos do projeto. Este recurso substitui o recurso da lista de permissões. O MongoDB Cloud removeu as listas de permissões em julho de 2021. Atualize seus aplicativos para usar este novo recurso. O ponto de extremidade /groups/{GROUP-ID}/accessList gerencia a lista de acesso IP do banco de dados. Este ponto de extremidade é diferente do ponto de extremidade orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist, que gerencia a lista de acesso para organizações do MongoDB Cloud. Esse ponto de extremidade não suporta solicitações POST simultâneas. Você deve enviar diversas solicitações POST de forma síncrona.

Lista de acesso IP

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Esquema do corpo da solicitação: application/json

Uma ou mais entradas da lista de acesso para adicionar ao projeto especificado.

Array

awsSecurityGroup	string^([0-9]/)?sg-([0-9]) String exclusiva de caracteres do grupo de segurança da Amazon Web Services (AWS) que você deseja adicionar à lista de acesso IP do projeto. Sua entrada na lista de acesso IP pode ser um awsSecurityGroup, um cidrBlock ou um ipAddress. Você deve configurar o emparelhamento Virtual Private Connection (VPC) para seu projeto antes de adicionar um grupo de segurança da AWS a uma lista de acesso IP. Não é possível definir grupos de segurança AWS como entradas de lista de acesso temporário. Não defina este parâmetro se você definir cidrBlock ou ipAddress.
cidrBlock	string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}... Faixa de endereços IP na notação CIDR (Classless Inter-Domain Routing) que você deseja adicionar à lista de acesso IP do projeto. Sua entrada na lista de acesso IP pode ser um awsSecurityGroup, um cidrBlock ou um ipAddress. Não defina este parâmetro se você definir awsSecurityGroup ou ipAddress.
comment	string <= 80 caracteres Lembrete que explica a finalidade ou o escopo desta entrada da lista de acesso IP.
deleteAfterDate	string <date-time> Data e hora após as quais o MongoDB Cloud exclui a entrada temporária da lista de acesso. Esse parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC e pode incluir a designação de fuso horário. A data deve ser posterior à data atual, mas não além de uma semana após o envio desta solicitação. O recurso retornará esse parâmetro se você tiver especificado uma data de expiração ao criar essa entrada de lista de acesso IP.
ipAddress	string^(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Endereço IP que você deseja adicionar à lista de acesso IP do projeto. Sua entrada na lista de acesso IP pode ser um awsSecurityGroup, um cidrBlock ou um ipAddress. Não defina esse parâmetro se você definir awsSecurityGroup ou cidrBlock.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"ipAddress": "string"
}
]

Exemplos de resposta

200
400
401
403
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"ipAddress": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

Remover uma entrada da lista de acesso IP de um projeto

Remove uma entrada da lista de acesso IP do projeto especificado. Cada entrada na lista de acesso IP do projeto contém um endereço IP, um bloco de endereços IP com notação CIDR ou um ID do AWS Security Group. O MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto". Este recurso substitui o recurso da lista de permissões. O MongoDB Cloud removeu as listas de permissões em julho de 2021. Atualize seus aplicativos para usar este novo recurso. O ponto de extremidade /groups/{GROUP-ID}/accessList gerencia a lista de acesso IP do banco de dados. Este ponto de extremidade é diferente do ponto de extremidade orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist, que gerencia a lista de acesso para organizações do MongoDB Cloud.

Lista de acesso IP

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

entryValue

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

Exemplo: IPv4: 192,0,2,0%2F24 ou IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 ou IPv4 CIDR: 198,51,100,0%2f24 ou IPv6 CIDR: 2001:db8::%2f58 ou AWS SG: sg-903004f8

Entrada da lista de acesso que você deseja remover da lista de acesso IP do projeto. Esse valor pode usar uma das seguintes opções: um ID de grupo de segurança da AWS, um endereço IP ou um bloco de endereços CIDR. Para blocos CIDR que usam uma máscara de sub-rede, substitua a barra (/) pelo seu valor codificado para URL (%2F). Quando você remove uma entrada da lista de acesso IP, as conexões existentes dos endereços removidos podem permanecer abertas por um período variável. O tempo que o MongoDB Cloud leva para fechar a conexão depende de vários fatores, incluindo:

como seu aplicativo estabeleceu a conexão,
como o MongoDB Cloud ou o driver que usa o endereço se comporta e
o protocolo (por exemplo, TCP ou UDP) que a conexão utiliza.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
403
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar entrada da lista de acesso IP de um projeto

Retorna uma entrada de lista de acesso IP do projeto especificado. Cada entrada na lista de acesso IP do projeto contém um endereço IP ou um bloco de endereços IP com notação CIDR. O MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Para usar esse recurso, a chave de API solicitante deve ter as funções Somente leitura do projeto ou Administrador de gráficos do projeto. Este recurso substitui o recurso da lista de permissões. O MongoDB Cloud removeu as listas de permissões em julho de 2021. Atualize seus aplicativos para usar este novo recurso. Este ponto de extremidade (/groups/{GROUP-ID}/accessList) gerencia a lista de acesso IP do projeto. Ele não gerencia a lista de acesso para organizações MongoDB Cloud. O ponto de extremidade API de chaves programáticas (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) gerencia essas listas de acesso.

Lista de acesso IP

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

entryValue

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

Exemplo: IPv4: 192,0,2,0%2F24 ou IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 ou IPv4 CIDR: 198,51,100,0%2f24 ou IPv6 CIDR: 2001:db8::%2f58 ou AWS SG: sg-903004f8

Entrada da lista de acesso que você deseja retornar da lista de acesso IP do projeto. Esse valor pode usar uma das seguintes opções: um ID de grupo de segurança da AWS, um endereço IP ou um bloco de endereços CIDR. Para blocos CIDR que usam uma máscara de sub-rede, substitua a barra (/) pelo seu valor codificado para URL (%2F).

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
403
404
500

Tipo de conteúdo

aplicação/json

{"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"ipAddress": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

Status de retorno de uma entrada da lista de acesso IP do projeto

Retorna o status de uma entrada da lista de acesso IP do projeto. Este recurso verifica se a entrada da lista de acesso IP do projeto fornecido se aplica a todos os provedores de serviços de nuvem que fornecem clusters do projeto especificado.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

entryValue

necessário

string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

Exemplo: IPv4: 192,0,2,0%2F24 ou IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 ou IPv4 CIDR: 198,51,100,0%2f24 ou IPv6 CIDR: 2001:db8::%2f58 ou AWS SG: sg-903004f8

Endereço de rede ou construção de segurança do provedor de nuvem que identifica qual entrada da lista de acesso do projeto deve ser verificada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"STATUS": "PENDING"
}

Projetos

Retorna, adiciona e edita coleções de clusters e usuários no MongoDB Cloud.

Retornar todos os projetos

Retorna detalhes sobre todos os projetos. Projeta clusters de grupos em coleções lógicas compatíveis com um ambiente de aplicativo, carga de trabalho ou ambos. Cada projeto pode ter seus próprios usuários, equipes, segurança, tags e configurações de alerta. Para usar esse recurso, a chave de API solicitante deve ter a função "Somente leitura da organização" ou superior.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}
],
"totalCount": 0
}

Criar um projeto

Cria um projeto. Projeta clusters de grupos em collections lógicas compatíveis com um ambiente de aplicativo, volume de trabalho ou ambos. Cada projeto pode ter seus próprios usuários, equipes, segurança, marcações e configurações de alerta. Para usar esse recurso, a chave API solicitante deve ter a role Leitura e Gravação.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
projectOwnerId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud a quem conceder a função "Proprietário do projeto" no projeto especificado. Se você definir este parâmetro, ele substituirá o valor padrão do proprietário da organização mais antigo.

Esquema do corpo da solicitação: application/json

Cria um projeto.

name

necessário

string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Etiqueta legível por humanos que identifica o projeto incluído na organização MongoDB Cloud.

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica a organização MongoDB Cloud à qual o projeto pertence.

regionUsageRestrictions

string

Padrão: "COMMERCIAL_FEDRAMP_REGIONS_ONLY"

Enum: "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "GOV_REGIONS_ONLY"

Aplica-se apenas ao Atlas for Government.

No Atlas Comercial, esse campo será rejeitado nas solicitações e estará ausente nas respostas.

Este campo define restrições em regiões disponíveis no projeto.

Valor	Regiões disponíveis
`COMMERCIAL_FEDRAMP_REGIONS_ONLY`	Permite apenas implantações em regiões FedRAMP Moderadas.
`GOV_REGIONS_ONLY`	Permite apenas implantações em regiões GovCloud.

https://www.mongodb.com/pt-br/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions

Array de objetos (Tag do recurso)

Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o projeto.

Resource Tags

withDefaultAlertsSettings

booleano

Padrão: true

Sinalizador que indica se você deve criar o projeto com as configurações de alerta padrão.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
],
"withDefaultAlertsSettings": true
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}

Retorne um projeto usando seu nome

Retorna detalhes sobre o projeto especificado. Projeta clusters de grupos em collections lógicas compatíveis com um ambiente de aplicativo, volume de trabalho ou ambos. Cada projeto pode ter seus próprios usuários, equipes, segurança, marcações e configurações de alerta. Para usar esse recurso, a chave da API solicitante deve ter a role de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupName

necessário

string [ 1 ... 64 ] caracteres

Etiqueta legível por humanos que identifica esse projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}

Remover um projeto

Remove o projeto especificado. Projeta clusters de grupos em collections lógicas compatíveis com um ambiente de aplicativo, volume de trabalho ou ambos. Cada projeto pode ter seus próprios usuários, equipes, segurança, marcações e configurações de alerta. Você pode excluir um projeto somente se não houver Online Archives para os clusters no projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
409
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um projeto

Retorna detalhes sobre o projeto especificado. Projeta clusters de grupos em collections lógicas compatíveis com um ambiente de aplicativo, volume de trabalho ou ambos. Cada projeto pode ter seus próprios usuários, equipes, segurança, marcações e configurações de alerta. Para usar esse recurso, a chave da API solicitante deve ter a role de Somente Leitura do Projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}

Atualizar um projeto

Atualiza a etiqueta legível para humanos que identifica o projeto especificado ou as tags associadas ao projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Projeto para atualizar.

name	string Etiqueta legível por humanos que identifica o projeto incluído na organização MongoDB Cloud.
	Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o projeto. Resource Tags

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string",
"tags": [{"key": "string",
"value": "string"
}
]
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"clusterCount": 0,
"created": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [{"key": "string",
"value": "string"
}
]
}

Retornar todos os convites do projeto

Retorna todos os convites pendentes para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
nome de usuário	string <email> Endereço de e-mail da conta de usuário convidada para esse projeto.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

[{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}
]

Atualizar um convite de projeto

Atualiza as informações de um convite pendente para o projeto especificado. Para especificar qual convite atualizar, forneça o nome de usuário do usuário convidado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualiza as informações de um convite pendente para o projeto especificado.

roles	Array de strings unique Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" Uma ou mais funções de nível de projeto a serem atribuídos ao usuário do MongoDB Cloud.
nome de usuário	string <email> Endereço de e-mail do usuário do MongoDB Cloud convidado para o projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Convidar um usuário do MongoDB Cloud para participar de um projeto

Convida um usuário do MongoDB Cloud para participar do projeto especificado. O usuário do MongoDB Cloud deve aceitar o convite para acessar informações dentro do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Convidar um usuário do MongoDB Cloud para participar do projeto especificado.

roles	Array de strings unique Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" Uma ou mais funções de nível de projeto a serem atribuídos ao usuário do MongoDB Cloud.
nome de usuário	string <email> Endereço de e-mail do usuário do MongoDB Cloud convidado para o projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Cancelar um convite de projeto

Cancela um convite pendente enviado ao usuário específico do MongoDB Cloud para participar de um projeto. Você não pode cancelar um convite que o usuário aceitou. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

invitationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
401
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um convite de projeto

Retorna as informações de um convite pendente para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

invitationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Atualizar um convite de projeto por ID de convite

Atualiza as informações de um convite pendente para o projeto especificado. Para especificar o convite a ser atualizado, forneça a string de identificação exclusiva desse convite. Use o ponto de extremidade "Retornar todos os convites do projeto" para recuperar IDs de todos os convites de projetos pendentes. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

invitationId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica o convite.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Atualiza as informações de um convite pendente para o projeto especificado.

roles

Array de strings unique

Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

Uma ou mais funções no nível da organização ou do projeto a serem atribuídas ao usuário do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"roles": ["GROUP_CLUSTER_MANAGER"
]
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "user@example.com",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": ["GROUP_CLUSTER_MANAGER"
],
"username": "user@example.com"
}

Retornar todos os limites para um projeto

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

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

[{"currentUsage": 0,
"defaultLimit": 0,
"maximumLimit": 0,
"name": "string",
"value": 0
}
]

Remover um limite de projeto

Remove o limite de projeto especificado. Dependendo do limite, o Atlas redefine o limite para seu valor padrão ou remove o limite completamente. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

limitName

necessário

string

Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

Etiqueta legível por humanos que identifica este limite de projeto.

Nome do limite	Descrição	Default	Limite de substituição da API
atlas.project.deployment.clusters	Limite do número de clusters neste projeto se a organização não for vendida para vendas (se a organização estiver vendida, o limite é 100)	25	90
atlas.project.deployment.nodesPerPrivateLinkRegion	Limite do número de nós por região de link privado neste projeto	50	90
atlas.project.security.databaseAccess.customRoles	Limite o número de funções personalizados neste projeto	100	1400
atlas.project.security.databaseAccess.users	Limite do número de usuários do banco de dados neste projeto	100	900
atlas.project.security.networkAccess.crossRegionEntries	Limite no número de entradas de acesso à rede entre regiões neste projeto	40	220
atlas.project.security.networkAccess.entries	Limite no número de entradas de acesso à rede neste projeto	200	20
dataFederation.bytesProcessed.query	Limite do número de bytes processados durante uma única consulta do Data Federation	N/A	N/A
dataFederation.bytesProcessed.daily	Limite do número de bytes processados em todos os locatários do Data Federation para o dia atual	N/A	N/A
dataFederation.bytesProcessed.weekly	Limite do número de bytes processados em todos os locatários do Data Federation para a semana atual	N/A	N/A
dataFederation.bytesProcessed.monthly	Limite do número de bytes processados em todos os locatários do Data Federation para o mês atual	N/A	N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup	Número de conexões de serviço privado por grupo de regiões	50	100
atlas.project.deployment.privateServiceConnectionsSubnetMask	Máscara de sub-rede para redes PSC GCP. Tem limite inferior de 20.	27	27
atlas.project.deployment.salesSoldM0s	Limite do número de clusters M0 neste projeto se a organização não tiver mais outros disponíveis	100	100

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
404
409
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um limite para um projeto

Retorna o limite especificado para o projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

limitName

necessário

string

Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

Etiqueta legível por humanos que identifica este limite de projeto.

Nome do limite	Descrição	Default	Limite de substituição da API
atlas.project.deployment.clusters	Limite do número de clusters neste projeto se a organização não for vendida para vendas (se a organização estiver vendida, o limite é 100)	25	90
atlas.project.deployment.nodesPerPrivateLinkRegion	Limite do número de nós por região de link privado neste projeto	50	90
atlas.project.security.databaseAccess.customRoles	Limite o número de funções personalizados neste projeto	100	1400
atlas.project.security.databaseAccess.users	Limite do número de usuários do banco de dados neste projeto	100	900
atlas.project.security.networkAccess.crossRegionEntries	Limite no número de entradas de acesso à rede entre regiões neste projeto	40	220
atlas.project.security.networkAccess.entries	Limite no número de entradas de acesso à rede neste projeto	200	20
dataFederation.bytesProcessed.query	Limite do número de bytes processados durante uma única consulta do Data Federation	N/A	N/A
dataFederation.bytesProcessed.daily	Limite do número de bytes processados em todos os locatários do Data Federation para o dia atual	N/A	N/A
dataFederation.bytesProcessed.weekly	Limite do número de bytes processados em todos os locatários do Data Federation para a semana atual	N/A	N/A
dataFederation.bytesProcessed.monthly	Limite do número de bytes processados em todos os locatários do Data Federation para o mês atual	N/A	N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup	Número de conexões de serviço privado por grupo de regiões	50	100
atlas.project.deployment.privateServiceConnectionsSubnetMask	Máscara de sub-rede para redes PSC GCP. Tem limite inferior de 20.	27	27
atlas.project.deployment.salesSoldM0s	Limite do número de clusters M0 neste projeto se a organização não tiver mais outros disponíveis	100	100

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

atlas.project.deployment.clusters

{"currentUsage": 0,
"defaultLimit": 0,
"maximumLimit": 0,
"name": "atlas.project.deployment.clusters",
"value": 0
}

Definir um limite de projeto

Define o limite do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

OBSERVAÇÃO: o aumento dos limites de configuração a seguir pode resultar em tempos de resposta mais lentos na interface do usuário do MongoDB Cloud ou no aumento da sobrecarga de gerenciamento de usuários, levando a uma rearquitetura de autenticação ou autorização. Se possível, recomendamos que você crie projetos adicionais para obter acesso a mais desses recursos para um padrão de crescimento sustentável.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

limitName

necessário

string

Enum: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask" "atlas.project.deployment.salesSoldM0s"

Etiqueta legível por humanos que identifica este limite de projeto.

Nome do limite	Descrição	Default	Limite de substituição da API
atlas.project.deployment.clusters	Limite do número de clusters neste projeto se a organização não for vendida para vendas (se a organização estiver vendida, o limite é 100)	25	90
atlas.project.deployment.nodesPerPrivateLinkRegion	Limite do número de nós por região de link privado neste projeto	50	90
atlas.project.security.databaseAccess.customRoles	Limite o número de funções personalizados neste projeto	100	1400
atlas.project.security.databaseAccess.users	Limite do número de usuários do banco de dados neste projeto	100	900
atlas.project.security.networkAccess.crossRegionEntries	Limite no número de entradas de acesso à rede entre regiões neste projeto	40	220
atlas.project.security.networkAccess.entries	Limite no número de entradas de acesso à rede neste projeto	200	20
dataFederation.bytesProcessed.query	Limite do número de bytes processados durante uma única consulta do Data Federation	N/A	N/A
dataFederation.bytesProcessed.daily	Limite do número de bytes processados em todos os locatários do Data Federation para o dia atual	N/A	N/A
dataFederation.bytesProcessed.weekly	Limite do número de bytes processados em todos os locatários do Data Federation para a semana atual	N/A	N/A
dataFederation.bytesProcessed.monthly	Limite do número de bytes processados em todos os locatários do Data Federation para o mês atual	N/A	N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup	Número de conexões de serviço privado por grupo de regiões	50	100
atlas.project.deployment.privateServiceConnectionsSubnetMask	Máscara de sub-rede para redes PSC GCP. Tem limite inferior de 20.	27	27
atlas.project.deployment.salesSoldM0s	Limite do número de clusters M0 neste projeto se a organização não tiver mais outros disponíveis	100	100

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Limite para atualização.

valor

necessário

inteiro <int64>

Valor da definição do limite.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

atlas.project.deployment.clusters

{"value": 0,
"name": "atlas.project.deployment.clusters"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

Exemplo

atlas.project.deployment.clusters

{"currentUsage": 0,
"defaultLimit": 0,
"maximumLimit": 0,
"name": "atlas.project.deployment.clusters",
"value": 0
}

Retornar configurações de um projeto

Retorna detalhes sobre as configurações do projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
403
404
500

Tipo de conteúdo

aplicação/json

{"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}

Atualizar configurações de um projeto

Atualiza as configurações do projeto especificado. Você pode atualizar qualquer uma das opções disponíveis. A nuvem do MongoDB atualiza apenas as opções fornecidas na solicitação. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Configurações a serem atualizadas.

isCollectDatabaseSpecificsStatisticsEnabled	booleano Sinalizador que indica se é necessário coletar métricas específicas do banco de dados para o projeto especificado.
isDataExplorerEnabled	booleano Sinalizador que indica se o Data Explorer deve ser ativado para o projeto especificado.
isExtendedStorageSizesEnabled	booleano Sinalizador que indica se os tamanhos de armazenamento estendidos devem ser habilitados para o projeto especificado.
isPerformanceAdvisorEnabled	booleano Sinalizador que indica se o Performance Advisor e o Profiler devem ser habilitados para o projeto especificado.
isRealtimePerformancePanelEnabled	booleano Sinalizador que indica se deseja ativar o Painel de desempenho em tempo real para o projeto especificado.
isSchemaAdvisorEnabled	booleano Sinalizador que indica se o Schema Advisor deve ser ativado para o projeto especificado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}

Exemplos de resposta

200
401
403
404
500

Tipo de conteúdo

aplicação/json

{"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}

Retornar todos os usuários de um projeto

Retorna detalhes sobre todos os usuários no projeto especificado. Os usuários pertencem a uma organização. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
flattenTeams	booleano Padrão: false Sinalizador que indica se a lista retornada deve incluir usuários que pertencem a uma equipe com uma função neste projeto. Talvez você não tenha atribuído uma função aos usuários individuais neste projeto. Se `"flattenTeams" : false`, este recurso retornará apenas usuários com uma função no projeto. Se `"flattenTeams" : true`, este recurso retornará tanto os usuários com funções no projeto quanto os usuários que pertencem a equipes com funções no projeto.
includeOrgUsers	booleano Padrão: false Sinalizador que indica se a lista retornada deve incluir usuários com acesso implícito ao projeto e às funções "Proprietário da organização" ou "Somente leitura da organização". Talvez você não tenha atribuído uma função aos usuários individuais neste projeto. Se `"includeOrgUsers": false`, este recurso retornará apenas usuários com uma função no projeto. Se `"includeOrgUsers": true`, este recurso retornará usuários com funções no projeto e usuários com acesso implícito ao projeto por meio de sua função da organização.

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}
],
"totalCount": 0
}

Remover um usuário de um projeto

Remove o usuário especificado do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

ID do usuário

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de caracteres de 24 hexadecimais que identifica o usuário do MongoDB Cloud que você deseja remover do projeto especificado. Para retornar o ID de um usuário de aplicativo usando o nome de usuário do aplicativo, use o ponto de extremidade Obtenha todos os usuários o aplicativo de um projeto.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

400
403
404
500

Tipo de conteúdo

aplicação/json

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

Índice de rolagem

Cria um índice para uma implantação de banco de dados contínuo. Você não pode criar um índice contínuo em um cluster gratuito do M0 ou cluster compartilhado do M2/M5.

Criar um índice contínuo

Cria um índice no cluster identificado por seu nome de forma contínua. A construção de índice dessa forma permite a construção de índice em um nó do conjunto de réplicas como um autônomo de cada vez, começando pelos nós secundários. A construção de índice dessa forma requer pelo menos uma eleição de conjunto de réplicas. Para usar este recurso, a chave de API solicitante deve ter a função de administrador de acesso aos dados do projeto.

Construção contínua de índices em conjuntos réplicas

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster no qual o MongoDB Cloud cria um índice.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Índice contínuo a ser criado no cluster especificado.

	objeto (Collation) Uma ou mais configurações que especificam regras específicas da linguagem para comparar strings nesse índice. Opções de agrupamento
collection necessário	string Etiqueta legível por humanos da coleção para a qual o MongoDB Cloud cria um índice.
db necessário	string Etiqueta legível por humanos do banco de dados que contém a coleção na qual o MongoDB Cloud cria um índice.
	Array de objetos[ items = 1 properties ] Lista que contém um ou mais objetos que descrevem os parâmetros que você deseja indexar.
	objeto (IndexOptions) Uma ou mais configurações que determinam como o MongoDB Cloud cria este índice MongoDB. Opções de índice

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

2dspere Index

{"collation": {"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"locale": "af",
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false,
"strength": 3
},
"collection": "accounts",
"db": "sample_airbnb",
"keys": [{"property_type": "1"
}
],
"options": {"name": "PartialIndexTest",
"partialFilterExpression": {"limit": {"$gt": 900
}
}
}
}

Exemplos de resposta

400
404
500

Tipo de conteúdo

aplicação/json

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

Raiz

Retorna detalhes que descrevem a compilação do MongoDB Cloud e o token de acesso que solicita este recurso. Isso inicia a API do MongoDB Cloud.

Retornar o status deste aplicativo do MongoDB

Esse recurso retorna informações sobre o aplicativo MongoDB junto com os metadados da chave API.

Autorizações:

DigestAuthContas de serviço

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
401
500

Tipo de conteúdo

aplicação/json

{"apiKey": {"accessList": [{"cidrBlock": "string",
"ipAddress": "string"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"publicKey": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
]
},
"appName": "MongoDB Atlas",
"build": "83be55e140f493c88e7f578aae96548dd881587b",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"throttling": true
}

Instâncias sem servidor

Retorna, adiciona, edita e remove instâncias sem servidor.

Retornar todas as instâncias sem servidor de um projeto

Retorna detalhes de todas as instâncias sem servidor no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
409
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}
],
"totalCount": 0
}

Criar uma instância sem servidor em um projeto

Cria uma instância sem servidor no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Cria uma instância sem servidor em um projeto.

name necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Rótulo legível por humanos que identifica a instância sem servidor.
necessário	objeto (Configurações do fornecedor de serviços em nuvem para uma instância sem servidor) Grupo de configurações do fornecedor de nuvem que definem a instância sem servidor do MongoDB provisionada.
	objeto (Opções de backup sem servidor) Grupo de configurações que configuram o backup sem servidor.
	Array de objetos (Tag do recurso) Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância sem servidor.
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada na instância sem servidor. Se definido para `true`, o MongoDB Cloud não excluirá a instância sem servidor. Se definido para `false`, o MongoDB Cloud excluirá a instância sem servidor.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Exemplos de resposta

201
400
402
409
500

Tipo de conteúdo

aplicação/json

{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Remover uma instância sem servidor de um único projeto

Remove uma instância sem servidor do projeto especificado. A instância sem servidor deve ter a proteção de encerramento desativada para ser excluída. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

name

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

202
400
404
409
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma instância sem servidor de um projeto

Retorna detalhes para uma instância sem servidor no projeto especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

name

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
409
500

Tipo de conteúdo

aplicação/json

{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Atualizar uma instância sem servidor em um projeto

Atualiza uma instância sem servidor no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

name

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Rótulo legível por humanos que identifica a instância sem servidor.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Atualize uma instância sem servidor em um projeto.

	objeto (Opções de backup sem servidor) Grupo de configurações que configuram o backup sem servidor.
	Array de objetos (Tag do recurso) Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância sem servidor.
terminationProtectionEnabled	booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada na instância sem servidor. Se definido para `true`, o MongoDB Cloud não excluirá a instância sem servidor. Se definido para `false`, o MongoDB Cloud excluirá a instância sem servidor.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Exemplos de resposta

200
400
402
409

Tipo de conteúdo

aplicação/json

{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

Endpoints privados sem servidor

Retorna, adiciona, edita e remove pontos de extremidade privados para instâncias sem servidor. Para saber mais, consulte a aba da API de Administração do Atlas no tutorial a seguir.

Tutorial de configuração de um ponto de extremidade privado para uma instância sem servidor

Retornar todos os endpoints privados para uma instância sem servidor

Retorna todos os pontos de extremidade privados para uma instância sem servidor. Você deve ter pelo menos a função "Somente leitura do projeto" para que o projeto chame esse recurso com sucesso.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

instanceName

necessário

string <= 64 caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica a instância sem servidor associada ao ponto de extremidade do locatário.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

[{"_id": "32b6e34b3d91647abb20e7b8",
"cloudProviderEndpointId": "string",
"comment": "string",
"endpointServiceName": "string",
"errorMessage": "string",
"status": "RESERVATION_REQUESTED",
"providerName": "AWS"
}
]

Criar um endpoint privado para uma instância sem servidor

Cria um ponto de extremidade privado para uma instância sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Um novo ponto de extremidade não estará imediatamente disponível após a criação. Leia as etapas do tutorial relacionado para obter orientações detalhadas.

Tutorial de configuração de um ponto de extremidade privado para uma instância sem servidor

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

instanceName

necessário

string <= 64 caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica a instância sem servidor para a qual o ponto de extremidade do locatário será criado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Informações sobre o ponto de extremidade privado a ser criado para a instância sem servidor.

comment

string <= 80 caracteres

Comentário legível por humanos associado ao ponto de extremidade privado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"comment": "string"
}

Exemplos de resposta

201
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"_id": "32b6e34b3d91647abb20e7b8",
"cloudProviderEndpointId": "string",
"comment": "string",
"endpointServiceName": "string",
"errorMessage": "string",
"providerName": "AWS",
"status": "RESERVATION_REQUESTED"
}

Remover um endpoint privado para uma instância sem servidor

Remova um ponto de extremidade privado de uma instância sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
instanceName necessário	string <= 64 caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica a instância sem servidor da qual o ponto de extremidade do locatário será removido.
endpointId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de caracteres de 24 dígitos hexadecimais que identifica o ponto de extremidade do locatário que será removido.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

204
400
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar um endpoint privado para uma instância sem servidor

Retorne um ponto de extremidade privado para uma instância sem servidor. Identifique esse ponto de extremidade usando sua ID exclusiva. Você deve ter pelo menos a função "Somente leitura do projeto" para que o projeto chame esse recurso com sucesso.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
instanceName necessário	string <= 64 caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica a instância sem servidor associada ao ponto de extremidade do locatário.
endpointId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o ponto de extremidade do locatário.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"_id": "32b6e34b3d91647abb20e7b8",
"cloudProviderEndpointId": "string",
"comment": "string",
"endpointServiceName": "string",
"errorMessage": "string",
"providerName": "AWS",
"status": "RESERVATION_REQUESTED"
}

Atualizar um endpoint privado para uma instância sem servidor

Atualiza um ponto de extremidade privado para uma instância sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
instanceName necessário	string <= 64 caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica a instância sem servidor associada ao ponto de extremidade do locatário que será atualizado.
endpointId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o ponto final do locatário que será atualizado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Esquema do corpo da solicitação: application/json

Objeto usado para atualização.

comment	string <= 80 caracteres Comentário legível por humanos associado ao ponto de extremidade privado.
providerName necessário	string Etiqueta legível por humanos que identifica o provedor de nuvem do ponto de extremidade do locatário AWS
cloudProviderEndpointId	string^vpce-[0-9a-f]{17}$ String exclusiva que identifica a interface de rede do ponto de extremidade privado.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"comment": "string",
"providerName": "AWS",
"cloudProviderEndpointId": "string"
}

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

Exemplo

AWS

{"_id": "32b6e34b3d91647abb20e7b8",
"cloudProviderEndpointId": "string",
"comment": "string",
"endpointServiceName": "string",
"errorMessage": "string",
"providerName": "AWS",
"status": "RESERVATION_REQUESTED"
}

Tarefas de restauração de nível compartilhado

Retorna e adiciona trabalhos de restauração para implantação de banco de dados de camada compartilhada.

Criar uma tarefa de restauração a partir de um cluster M2 ou M5

Restaura o cluster especificado. O MongoDB Cloud limita quais clusters podem ser destino de uma restauração. O cluster de destino não pode usar criptografia em repouso, executar uma versão principal do MongoDB diferente do snapshot ou receber solicitações de clientes durante as restaurações. O MongoDB Cloud exclui todos os dados existentes no cluster de destino antes da operação de restauração. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Os detalhes do trabalho de restauração.

snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o snapshot a ser restaurado.
targetDeploymentItemName necessário	string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$ Etiqueta legível por humanos que identifica o cluster no projeto de destino para o qual você deseja restaurar o snapshot. Você pode restaurar o snapshot para uma camada do cluster M2 ou superior.
targetProjectId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de caracteres de 24 dígitos hexadecimais que identifica o projeto que contém o cluster no qual você deseja restaurar o snapshot.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"deliveryType": "RESTORE",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreFinishedDate": "2019-08-24T14:15:22Z",
"restoreScheduledDate": "2019-08-24T14:15:22Z",
"snapshotFinishedDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"snapshotUrl": "string",
"status": "PENDING",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Retornar todos os trabalhos de restauração para um cluster M2 ou M5

Retorna todos os trabalhos de restauração para o cluster M2 ou M5 especificado. Restaure trabalhos restaurando um cluster usando um snapshot. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusterName": "string",
"deliveryType": "RESTORE",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreFinishedDate": "2019-08-24T14:15:22Z",
"restoreScheduledDate": "2019-08-24T14:15:22Z",
"snapshotFinishedDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"snapshotUrl": "string",
"status": "PENDING",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}
],
"totalCount": 0
}

Retornar um trabalho de restauração para um cluster M2 ou M5

Retorna o trabalho de restauração especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
restoreId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser retornada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"deliveryType": "RESTORE",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreFinishedDate": "2019-08-24T14:15:22Z",
"restoreScheduledDate": "2019-08-24T14:15:22Z",
"snapshotFinishedDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"snapshotUrl": "string",
"status": "PENDING",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Snapshots de camada compartilhada

Retorna e solicita o download de snapshots da implantação de banco de dados de camada compartilhada.

Baixar um snapshot de cluster M2 ou M5

Solicita um snapshot para o cluster compartilhado especificado. Esse recurso retorna um snapshotURL que você pode utilizar para baixar o snapshot. Esse snapshotURL permanece ativo por quatro horas após a solicitação. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Snapshot a ser baixado.

snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o snapshot a ser restaurado.
targetDeploymentItemName necessário	string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$ Etiqueta legível por humanos que identifica o cluster no projeto de destino para o qual você deseja restaurar o snapshot. Você pode restaurar o snapshot para uma camada do cluster M2 ou superior.
targetProjectId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de caracteres de 24 dígitos hexadecimais que identifica o projeto que contém o cluster no qual você deseja restaurar o snapshot.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"clusterName": "string",
"deliveryType": "RESTORE",
"expirationDate": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreFinishedDate": "2019-08-24T14:15:22Z",
"restoreScheduledDate": "2019-08-24T14:15:22Z",
"snapshotFinishedDate": "2019-08-24T14:15:22Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"snapshotUrl": "string",
"status": "PENDING",
"targetDeploymentItemName": "string",
"targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Retornar todos os snapshots para um cluster M2 ou M5

Retorna detalhes para todos os snapshots do cluster compartilhado especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

clusterName

necessário

string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$

Etiqueta legível por humanos que identifica o cluster.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"expiration": "2019-08-24T14:15:22Z",
"finishTime": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"scheduledTime": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"status": "PENDING"
}
],
"totalCount": 0
}

Retornar um snapshot para um cluster M2 ou M5

Retorna detalhes de um snapshot do cluster compartilhado especificado. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dí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.
clusterName necessário	string [ 1 ... 64 ] caracteres ^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$ Etiqueta legível por humanos que identifica o cluster.
snapshotId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
404
500

Tipo de conteúdo

aplicação/json

{"expiration": "2019-08-24T14:15:22Z",
"finishTime": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"scheduledTime": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z",
"status": "PENDING"
}

Equipes

Retorna, adiciona, edita ou remove equipes.

Retornar todas as equipes de um projeto

Retorna todas as equipes às quais o usuário autenticado tem acesso no projeto especificado usando seu identificador exclusivo de 24 dígitos hexadecimais. Todos os membros da equipe compartilham o mesmo acesso ao projeto. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleNames": ["GROUP_CLUSTER_MANAGER"
],
"teamId": "32b6e34b3d91647abb20e7b8"
}
],
"totalCount": 0
}

Adicionar uma ou mais equipes a um projeto

Adiciona uma equipe ao projeto especificado. Todos os membros da equipe compartilham o mesmo acesso ao projeto. O MongoDB Cloud limita o número de usuários a um máximo de 100 equipes por projeto e a um máximo de 250 equipes por organização. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Equipe para adicionar ao projeto especificado.

Array

roleNames	Array de strings unique Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" Uma ou mais funções no nível da organização ou do projeto a serem atribuídos ao usuário do MongoDB Cloud.
teamId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica a equipe.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"roleNames": ["GROUP_CLUSTER_MANAGER"
],
"teamId": "32b6e34b3d91647abb20e7b8"
}
]

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleNames": ["GROUP_CLUSTER_MANAGER"
],
"teamId": "32b6e34b3d91647abb20e7b8"
}
],
"totalCount": 0
}

Remover uma equipe de um projeto

Remove uma equipe especificada usando seu identificador exclusivo de 24 dígitos hexadecimais do projeto especificado usando seu identificador exclusivo de 24 dígitos hexadecimais. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

teamId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica a equipe que você deseja remover do projeto especificado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

400
401
403
404
500

Tipo de conteúdo

aplicação/json

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

Atualizar roles de equipe em um projeto

Atualiza as funções do projeto atribuídas à equipe especificada. Você pode conceder funções de equipe para projetos específicos e conceder funções de acesso ao projeto aos usuários da equipe. Todos os membros da equipe compartilham o mesmo acesso ao projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

teamId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica a equipe para a qual você deseja atualizar funções.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

As funções do projeto atribuídas à equipe especificada.

roleNames	Array de strings unique Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" Uma ou mais funções no nível da organização ou do projeto a serem atribuídos ao usuário do MongoDB Cloud.
teamId	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica a equipe.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"roleNames": ["GROUP_CLUSTER_MANAGER"
],
"teamId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roleNames": ["GROUP_CLUSTER_MANAGER"
],
"teamId": "32b6e34b3d91647abb20e7b8"
}
],
"totalCount": 0
}

Retornar todas as equipes em uma organização

Retorna todas as equipes que pertencem à organização especificada. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. O MongoDB Cloud só retorna equipes para as quais você tem acesso. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}
],
"totalCount": 0
}

Criar uma equipe em uma organização

Cria uma equipe na organização especificada. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. O MongoDB Cloud limita o número de equipes a no máximo 250 equipes por organização. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 4888442a3354817a7320eb61

String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Equipe que você deseja criar na organização especificada.

name necessário	string Etiqueta legível por humanos que identifica a equipe.
usernames	Array de strings <email> unique Lista que contém os usuários do MongoDB Cloud nesta equipe.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string",
"usernames": ["user@example.com"
]
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"usernames": ["user@example.com"
]
}

Retornar uma equipe usando seu nome

Retorna uma equipe que você identificou usando seu nome legível por humanos. Esta equipe pertence a uma organização. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamName necessário	string Nome da equipe cujas informações você deseja devolver.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}

Remover uma equipe de uma organização

Remove uma equipe especificada usando seu identificador exclusivo de 24 dígitos hexadecimais da organização especificada usando seu identificador exclusivo de 24 dígitos hexadecimais. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a equipe que você deseja excluir.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma equipe usando seu ID

Retorna uma equipe que você identificou usando seu ID exclusivo de 24 dígitos hexadecimais. Esta equipe pertence a uma organização. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a equipe cujas informações você deseja retornar.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}

Renomear uma equipe

Renomeia uma equipe na organização especificada. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a equipe que você deseja renomear.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Detalhes para atualizar na equipe especificada.

name

necessário

string

Etiqueta legível por humanos que identifica a equipe.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"name": "string"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string"
}

Retornar todos os usuários do MongoDB Cloud atribuídos a uma equipe

Retorna todos os usuários do MongoDB Cloud atribuídos à equipe especificada usando seu identificador exclusivo de 24 dígitos hexadecimais. Esta equipe pertence a uma organização. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Para usar este recurso, a chave de API solicitante deve ter a função "Membro da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica a equipe cujos usuários do aplicativo você deseja retornar.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}
],
"totalCount": 0
}

Atribuir usuários do MongoDB Cloud de uma organização a uma equipe

Adiciona um ou mais usuários do MongoDB Cloud da organização especificada à equipe especificada. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Você pode atribuir até 250 usuários do MongoDB Cloud de uma organização para uma equipe. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de caracteres hexadecimais de 24 caracteres que identifica a equipe à qual você deseja adicionar usuários do MongoDB Cloud.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Um ou mais usuários do MongoDB Cloud que você deseja adicionar à equipe especificada.

Array

id

necessário

string = 24 caracteres ^([a-f0-9]{24})$

String exclusiva de 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

[{"id": "32b6e34b3d91647abb20e7b8"
}
]

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"emailAddress": "user@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2019-08-24T14:15:22Z",
"lastName": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "stringst",
"roles": [{"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_OWNER"
}
],
"teamIds": ["32b6e34b3d91647abb20e7b8"
],
"username": "user@example.com"
}
],
"totalCount": 0
}

Remover um usuário do MongoDB Cloud de uma equipe

Remove um usuário do MongoDB Cloud da equipe especificada. Esta equipe pertence a uma organização. As equipes permitem que você conceda funções de acesso ao projeto aos usuários do MongoDB Cloud. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização".

Gerenciar equipes da organização

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

orgId necessário	string = 24 caracteres ^([a-f0-9]{24})$ Exemplo: 4888442a3354817a7320eb61 String exclusiva de 24 dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para extrair todas as organizações às quais o usuário autenticado tem acesso.
teamId necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de caracteres de 24 dígitos hexadecimais que identifica a equipe da qual você deseja remover um usuário de aplicativo de banco de dados.
ID do usuário necessário	string = 24 caracteres ^([a-f0-9]{24})$ String exclusiva de 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud que você deseja remover da equipe especificada.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

400
401
404
500

Tipo de conteúdo

aplicação/json

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

Integrações de terceiros

Retorna, adiciona, edita e remove configurações de integração de serviços de terceiros. O MongoDB Cloud envia alertas para cada serviço de terceiros que você configura.

IMPORTANTE: cada projeto só pode ter uma configuração por integrationType.

Retornar todas as integrações de serviços de terceiros ativas

Retorna as configurações que permitem integrações com todos os serviços de terceiros configurados. Essas configurações se aplicam a todos os bancos de dados gerenciados em um projeto do MongoDB Cloud. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "string",
"type": "PAGER_DUTY"
}
],
"totalCount": 0
}

Remover uma integração de serviços de terceiros

Remove as configurações que permitem definir uma integração de serviços de terceiros. Essas configurações se aplicam a todos os bancos de dados gerenciados em um projeto do MongoDB Cloud. Se você excluir uma integração de um projeto, a configuração de integração será removida apenas desse projeto. Essa ação não afeta as integrações de {INTEGRATION-TYPE} configuradas de nenhum outro projeto ou organização. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

integrationType

necessário

string (Tipo de integração)

Enum: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

Etiqueta legível por humanos que identifica o serviço que você deseja integrar ao MongoDB Cloud.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

204
400
401
404
500

Tipo de conteúdo

aplicação/json

{ }

Retornar uma integração de serviço de terceiros

Retorna as configurações para configurar a integração com um serviço de terceiros. Essas configurações se aplicam a todos os bancos de dados gerenciados em um projeto do MongoDB Cloud. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

integrationType

necessário

string (Tipo de integração)

Enum: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

Etiqueta legível por humanos que identifica o serviço que você deseja integrar ao MongoDB Cloud.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Respostas

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

Exemplo

DATADOG

{"apiKey": "****************************a23c",
"id": "string",
"region": "US",
"type": "DATADOG"
}

Configurar uma integração de serviços de terceiros

Adiciona as configurações para configurar uma integração de serviço de terceiros. Essas configurações se aplicam a todos os bancos de dados gerenciados no projeto do MongoDB Cloud especificado. Cada projeto pode ter somente uma configuração por {INTEGRATION-TYPE}. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

integrationType

necessário

string (Tipo de integração)

Enum: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

Etiqueta legível por humanos que identifica o serviço que você deseja integrar ao MongoDB Cloud.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Esquema do corpo da solicitação: application/json

Integração de terceiros que você deseja configurar para seu projeto.

apiKey necessário	string Chave que permite ao MongoDB Cloud acessar sua conta Datadog. OBSERVAÇÃO: depois de criar uma notificação que exija uma chave de API ou de integração, a chave aparecerá parcialmente redigida quando: Visualize ou edite o alerta por meio da UI do Atlas. Acesse o query de alerta para a notificação na API de administração do Atlas.
id	string ou nulo ID de integração.
região	string Enum: "US" "EU" "US3" "US5" "AP1" "US1_FED" Código de duas letras que indica qual URL regional MongoDB usa para acessar a API Datadog. Para saber mais sobre as regiões do Datadog, consulte Sites do Datadog.
type	string Etiqueta legível por humanos que identifica o serviço ao qual você deseja integrar o MongoDB Cloud. O valor deve corresponder ao tipo de integração de serviço de terceiros. DATADOG

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

DATADOG

{"apiKey": "****************************a23c",
"id": "string",
"region": "US",
"type": "DATADOG"
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "string",
"type": "PAGER_DUTY"
}
],
"totalCount": 0
}

Atualizar uma integração de serviços de terceiros

Atualiza as configurações para configurar a integração com um serviço de terceiros. Essas configurações se aplicam a todos os bancos de dados gerenciados em um projeto do MongoDB Cloud. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário da organização" ou "Proprietário do projeto".

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

integrationType

necessário

string (Tipo de integração)

Enum: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

Etiqueta legível por humanos que identifica o serviço que você deseja integrar ao MongoDB Cloud.

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Esquema do corpo da solicitação: application/json

Integração de terceiros que você deseja configurar para seu projeto.

apiKey necessário	string Chave que permite ao MongoDB Cloud acessar sua conta Datadog. OBSERVAÇÃO: depois de criar uma notificação que exija uma chave de API ou de integração, a chave aparecerá parcialmente redigida quando: Visualize ou edite o alerta por meio da UI do Atlas. Acesse o query de alerta para a notificação na API de administração do Atlas.
id	string ou nulo ID de integração.
região	string Enum: "US" "EU" "US3" "US5" "AP1" "US1_FED" Código de duas letras que indica qual URL regional MongoDB usa para acessar a API Datadog. Para saber mais sobre as regiões do Datadog, consulte Sites do Datadog.
type	string Etiqueta legível por humanos que identifica o serviço ao qual você deseja integrar o MongoDB Cloud. O valor deve corresponder ao tipo de integração de serviço de terceiros. DATADOG

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

Exemplo

DATADOG

{"apiKey": "****************************a23c",
"id": "string",
"region": "US",
"type": "DATADOG"
}

Exemplos de resposta

200
400
401
404
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"id": "string",
"type": "PAGER_DUTY"
}
],
"totalCount": 0
}

Autenticação X.509

Retorna, edita e remove as configurações X.509 gerenciadas pelo usuário. Também retorna e gera certificados X.509 gerenciados pelo MongoDB Cloud para usuários do banco de dados. Os recursos a seguir ajudam a gerenciar usuários do banco de dados que se autenticam usando certificados X.509. Você pode gerenciar esses certificados X.509 ou deixar o MongoDB Cloud fazer isso por você. Se o MongoDB Cloud gerencia seus certificados, ele também gerencia sua autoridade de certificação e pode gerar certificados para os usuários do seu banco de dados. Nenhuma configuração X.509 adicional é necessária. Se você gerencia seus certificados, deve fornecer uma Autoridade de certificação e gerar certificados para os usuários do seu banco de dados.

Certificados X.509 autogerenciados

Retornar todos os certificados X.509 atribuídos a um usuário do MongoDB

Retorna todos os certificados X.509 expirados para o usuário MongoDB especificado. Esse usuário MongoDB pertence a um projeto. O Atlas gerencia esses certificados e o usuário MongoDB. Para usar esse recurso, a chave da API solicitante deve ter a função de Somente leitura do projeto.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

nome de usuário

necessário

string

Etiqueta legível por humanos que representa a conta de usuário do banco de dados MongoDB cujos certificados você deseja devolver.

parâmetros de query

envelope	booleano Padrão: false Exemplo: envelope=false 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.
incluir contagem	booleano Padrão: true Exemplo: includeCount=true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
itemsPerPage	inteiro [ 1 .. 500 ] Padrão: 100 Exemplo: itemsPerPage=100 Número de itens que a resposta retorna por página.
pageNum	inteiro >= 1 Padrão: 1 Exemplo: pageNum=1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
pretty	booleano Padrão: false Exemplo: pretty=false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

Respostas

Exemplos de resposta

200
400
401
500

Tipo de conteúdo

aplicação/json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"_id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"notAfter": "2019-08-24T14:15:22Z",
"subject": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com"
}
],
"totalCount": 0
}

Criar um certificado X.509 para um usuário do MongoDB

Gera um certificado X.509 para o usuário do MongoDB especificado. O Atlas gerencia o certificado e o usuário do MongoDB que pertencem a um projeto. Para usar esse recurso, a chave de API solicitante deve ter a função "Proprietário do projeto".

Para fazer o MongoDB Cloud gerar um certificado gerenciado para um usuário do banco de dados, configure o "x509Type" : "MANAGED" no usuário do banco de dados do MongoDB desejado.

Se você estiver gerenciando sua própria autoridade de certificação (CA) no modo X.509 autogerenciado, deverá gerar certificados para usuários de banco de dados usando sua própria CA.

X.509 autogerenciado

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

nome de usuário

necessário

string

Etiqueta legível por humanos que representa a conta de usuário do banco de dados do MongoDB para quem criar um certificado.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

pretty

booleano

Padrão: false

Exemplo: pretty=false

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

Esquema do corpo da solicitação: application/json

Gera um certificado X.509 para o usuário do MongoDB especificado.

monthsUntilExpiration

inteiro <int32> <= 24

Padrão: 3

Número de meses em que o certificado permanece válido até expirar.

Respostas

Solicitar amostras

Carga útil

Tipo de conteúdo

aplicação/json

{"monthsUntilExpiration": 3
}

Exemplos de resposta

Tipo de conteúdo

aplicação/json

"string"

Desabilitar X.509 gerenciado pelo cliente

Limpa as configurações do X.509 gerenciado pelo cliente em um projeto, incluindo a Autoridade de Certificação carregada, que desabilita o X.509 autogerenciado.

A atualização dessa configuração aciona uma reinicialização contínua do banco de dados. Você deve ter a função de Proprietário do Projeto para usar esse ponto de extremidade.

Autorizações:

DigestAuthContas de serviço

parâmetros de caminho

groupId

necessário

string = 24 caracteres ^([a-f0-9]{24})$

Exemplo: 32b6e34b3d91647abb20e7b8

Sequência única de 24 dí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.

parâmetros de query

envelope

booleano

Padrão: false

Exemplo: envelope=false

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.

Respostas

Exemplos de resposta

202
404
500

Tipo de conteúdo

aplicação/json

{"customerX509": {"cas": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"ldap": {"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636,
"userToDNMapping": [{"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}