API de administraĆ§Ć£o do MongoDB Atlas 2.0
  • 2023-11-15 (mais recente)
  • 2023-10-01
  • 2023-02-01
  • 2023-01-01
Documentos API da Redocly

API de administraĆ§Ć£o do MongoDB Atlas (2.0)

VersĆ£o do recurso 2023-11-15

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/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/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:
DigestAuth
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-]*$

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.

fim
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

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:
DigestAuth
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.

fim
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 eventos de cobranƧa (objeto) ou Tipos de eventos de backup Cps (objeto) ou Tipos de auditoria de Ć­ndice FTS (objeto) ou Tipos de eventos de grupo (objeto) ou Tipos de auditoria NDS (objeto) ou Tipos de auditoria de janela de manutenĆ§Ć£o NDS (objeto) ou Tipos de eventos de Online Archive (objeto) ou tipos de eventos do usuĆ”rio (objeto) ou tipos de eventos do recurso (objeto) ou tipos de eventos do processador de fluxo (objeto)

Incidente que acionou este alerta.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "notifications": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "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:
DigestAuth
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

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 eventos de cobranƧa (objeto) ou Tipos de eventos de backup Cps (objeto) ou Tipos de auditoria de Ć­ndice FTS (objeto) ou Tipos de eventos de grupo (objeto) ou Tipos de auditoria NDS (objeto) ou Tipos de auditoria de janela de manutenĆ§Ć£o NDS (objeto) ou Tipos de eventos de Online Archive (objeto) ou tipos de eventos do usuĆ”rio (objeto) ou tipos de eventos do recurso (objeto) ou tipos de eventos do processador de fluxo (objeto)

Incidente que acionou este alerta.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "notifications": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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": [],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Confirmar um alerta.

Um dos
acknowledgedUntil
necessƔrio
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, defina o valor do parĆ¢metro como uma data no passado.

acknowledgementComment
string <= 200 caracteres

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

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days."
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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.

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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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.

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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

Excluir nĆ³s de pesquisa

Exclui os nĆ³s de pesquisa para o cluster especificado.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo que identifica o cluster 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
{
  • "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 nĆ³s de pesquisa

Retornar os nĆ³s de pesquisa para o cluster especificado.

AutorizaƧƵes:
DigestAuth
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-]*$

Etiqueta que identifica o cluster para o qual retornar os nĆ³s de pesquisa.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

Atualizar nĆ³s de pesquisa

Atualiza os nĆ³s de pesquisa para o cluster especificado.

AutorizaƧƵes:
DigestAuth
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-]*$

Etiqueta que identifica o cluster para atualizar os nĆ³s de pesquisa.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Atualiza os nĆ³s de pesquisa para o cluster especificado.

necessƔrio
Array de objetos (ApiSearchDeploymentSpecView) = 1 item

Lista de configuraƧƵes que configuram os nĆ³s de pesquisa do seu cluster.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "specs": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

Criar nĆ³s de pesquisa

Cria nĆ³s de pesquisa para o cluster especificado.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo que identifica o cluster para o qual criar nĆ³s de pesquisa.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Cria nĆ³s de pesquisa para o cluster especificado.

necessƔrio
Array de objetos (ApiSearchDeploymentSpecView) = 1 item

Lista de configuraƧƵes que configuram os nĆ³s de pesquisa do seu cluster.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "specs": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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 AWS S3 usados para exportaƧƵes de snapshots de backup em nuvem

Retornar todos os blocos AWS S3 associados ao projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a funĆ§Ć£o de Somente Leitura do Projeto.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

Conceder acesso ao bucket AWS S3 para exportaƧƵes de snapshots de backup em nuvem

Concede acesso ao MongoDB Cloud ao bucket AWS S3 especificado. Permite que o bucket receba snapshots do backup do Atlas Cloud. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietƔrio do projeto.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Concede acesso ao MongoDB Cloud ao bucket AWS S3 especificado.

bucketName
string

Etiqueta legĆ­vel por humanos que identifica o bucket AWS que a funĆ§Ć£o estĆ” autorizada a acessar.

cloudProvider
string
Enum: "AWS" "AZURE" "GCP"

RĆ³tulo legĆ­vel por humanos que identifica o fornecedor de nuvem que armazena esse snapshot.

iamRoleId
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

Revogar acesso ao bucket AWS S3 para exportaƧƵes de snapshots de backup em nuvem

Revogar o acesso da nuvem do MongoDB Cloud ao bucket AWS S3 especificado. Isso impede que esse bucket receba snapshots de backup em nuvem do Atlas. A exportaĆ§Ć£o automĆ”tica deve ser desabilitada em todos os clusters desse projeto que sĆ£o exportados para esse bucket antes de revogar o acesso. Para utilizar esse recurso, a chave de API solicitante deve ter a funĆ§Ć£o de "ProprietĆ”rio do projeto".

AutorizaƧƵes:
DigestAuth
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 [ 3 ... 63 ] caracteres ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1.6...

String Ćŗnica que identifica o bucket da AWS S3 para o qual vocĆŖ exporta seus snapshots.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{ }

Retornar um bucket do AWS S3 usado para exportaƧƵes de snapshots de backup em nuvem

Retorna um bucket AWS S3 associado ao projeto especificado. Para usar este recurso, a chave da API solicitante deve possuir a funĆ§Ć£o de Somente Leitura do Projeto.

AutorizaƧƵes:
DigestAuth
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 [ 3 ... 63 ] caracteres ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1.6...

String Ćŗnica que identifica o bucket da AWS S3 para o qual vocĆŖ exporta seus snapshots.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

Retornar as configuraƧƵes da Polƭtica de compliance de backup

Retorna as configuraƧƵes da Polƭtica de compliance de backup com o projeto especificado. Para utilizar este recurso, a chave de API solicitante deve ter a role de proprietƔrio do projeto. VersƵes antigas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "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 utilizar esse recurso, a chave de API solicitante deve ter a funĆ§Ć£o de "ProprietĆ”rio do projeto". VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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

Sinalizador que indica se as polĆ­ticas de backup nĆ£o compatĆ­veis com as novas configuraƧƵes de proteĆ§Ć£o de dados devem ser substituĆ­das ou nĆ£o.

pretty
booleano
PadrĆ£o: false
Exemplo: pretty=false

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

Solicitar esquema de corpo: application/vnd.atlas.2023-10-01+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
necessƔrio
string

Nome do usuĆ”rio que autorizou a atualizaĆ§Ć£o das configuraƧƵes da PolĆ­tica de compliance de backup.

authorizedUserLastName
necessƔrio
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

Retornar todas as tarefas de exportaĆ§Ć£o de snapshot de backup em nuvem

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Criar uma tarefa de exportaĆ§Ć£o de snapshot de backup em nuvem

Exporta um snapshot de backup para um Atlas cluster dedicado usando backups na nuvem para um bucket da AWS. Para utilizar este recurso, a chave API solicitada deve ter a funĆ§Ć£o de Administrador do Projeto Atlas.

AutorizaƧƵes:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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})$

String Ćŗnica de 24 hexadecimais que identifica o bucket da AWS para o qual o MongoDB Cloud exporta o snapshot do backup em nuvem.

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

String Ćŗnica de 24 hexadecimais que identifica o snapshot do backup em nuvem a ser exportado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "deliveryUrl": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled"
}

Retornar uma tarefa de exportaĆ§Ć£o de snapshots de backup em nuvem

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:
DigestAuth
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-]*$

Etiqueta legĆ­vel por humanos que identifica o cluster.

exportId
necessƔrio
string

String Ćŗnica que identifica o bucket da AWS S3 para o qual vocĆŖ exporta seus snapshots.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "deliveryUrl": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 snapshots de backup em nuvem automaticamente para o bucket da AWS.

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 se os nomes da organizaĆ§Ć£o e do projeto devem ser usados em vez de UUIDs da organizaĆ§Ć£o e do projeto no caminho para os arquivos de metadados que o MongoDB Cloud carrega no bucket da AWS.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "description": "string",
  • "retentionInDays": 1
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "configServerType": "EMBEDDED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "members": [
    ],
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "snapshotIds": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "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:
DigestAuth
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

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "accessListIps": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "awsIamRoles": [
    ]
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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": [
    ],
  • "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:
DigestAuth
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
Valor: "AWS"

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

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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": [
    ],
  • "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 utilizar esse recurso, a chave de API solicitante deve ter a funĆ§Ć£o de "ProprietĆ”rio do projeto". Esse endpoint da API Ć© uma etapa em um procedimento para criar acesso unificado aos serviƧos do MongoDB Cloud.

Configurar acesso a provedores de nuvem
AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Descreve a simulaĆ§Ć£o de interrupĆ§Ć£o.

Array de objetos (AtlasClusterOutageSimulationOutageFilter) nĆ£o vazia

Lista de configuraƧƵes que especificam o tipo de simulaĆ§Ć£o de interrupĆ§Ć£o de cluster.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "outageFilters": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Retornar todos os clusters em um projeto descontinuado

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 da API solicitante deve ter a funĆ§Ć£o de "somente leitura" do projeto. Esta funcionalidade nĆ£o estĆ” disponĆ­vel para clusters sem servidor. VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Criar um cluster de um projeto descontinuado

Cria um cluster no projeto especificado. Os clusters contĆŖm um grupo de hospedagem que mantĆ©m o mesmo conjunto de dados. Este recurso pode criar clusters multinuvem. Cada projeto suporta atĆ© 25 sistemas de banco de dados. Para usar esse recurso, a chave de API solicitada deve ter a funĆ§Ć£o proprietĆ”rio do projeto. Esta funcionalidade nĆ£o estĆ” disponĆ­vel para clusters sem servidor. VersƵes antigas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+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.

diskSizeGB
nĆŗmero <double> [ 10 ... 4096 ]

Capacidade de armazenamento que o volume raiz do host tem expressada em gigabytes. Aumente esse nĆŗmero para aumentar a capacidade. 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 atualizar 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

Configure este 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 sharding gerenciado pelo Atlas. Esse modo gerencia totalmente a fragmentaĆ§Ć£o do seu cluster global e Ć© criado para fornecer uma experiĆŖncia de implantaĆ§Ć£o contĆ­nua.

Quando definido como true, o modo de gerenciamento Ć© definido como fragmentaĆ§Ć£o autogerenciada. Esse modo deixa o gerenciamento de shards em suas mĆ£os e foi criado para fornecer uma experiĆŖncia de sistema avanƧada e flexĆ­vel.

Esta 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
PadrĆ£o: "7.0"
Enum: "4.2" "4.4" "5.0" "6.0" "7.0"

VersĆ£o MongoDB principal do cluster. O MongoDB Cloud implementa o cluster com a versĆ£o estĆ”vel mais recente da versĆ£o especificada.

name
string [ 1 ... 64 ] caracteres ^[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
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 (MarcaĆ§Ć£o do recurso)

Lista que contƩm pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster.

Tags de recursos
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json

Cluster multinuvem

{
  • "clusterType": "REPLICASET",
  • "links": [ ],
  • "name": "multiCloud",
  • "replicationSpecs": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

diskSizeGB
nĆŗmero <double> [ 10 ... 4096 ]

Capacidade de armazenamento que o volume raiz do host tem expressada em gigabytes. Aumente esse nĆŗmero para aumentar a capacidade. 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 atualizar 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

Configure este 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 sharding gerenciado pelo Atlas. Esse modo gerencia totalmente a fragmentaĆ§Ć£o do seu cluster global e Ć© criado para fornecer uma experiĆŖncia de implantaĆ§Ć£o contĆ­nua.

Quando definido como true, o modo de gerenciamento Ć© definido como fragmentaĆ§Ć£o autogerenciada. Esse modo deixa o gerenciamento de shards em suas mĆ£os e foi criado para fornecer uma experiĆŖncia de sistema avanƧada e flexĆ­vel.

Esta 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
PadrĆ£o: "7.0"
Enum: "4.2" "4.4" "5.0" "6.0" "7.0"

VersĆ£o MongoDB principal do cluster. O MongoDB Cloud implementa o cluster com a versĆ£o estĆ”vel mais recente da versĆ£o especificada.

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-]*$

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.

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 (MarcaĆ§Ć£o do recurso)

Lista que contƩm pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster.

Tags de recursos
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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-]*$

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 (MarcaĆ§Ć£o 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

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 usar esse recurso, a chave de API solicitante deve ter a role de proprietĆ”rio do projeto. Essa funcionalidade nĆ£o estĆ” disponĆ­vel para clusters sem servidor. VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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-]*$

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

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 obsoleto

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 da API solicitante deve ter a funĆ§Ć£o de "somente leitura" do projeto. Esta funcionalidade nĆ£o estĆ” disponĆ­vel para clusters sem servidor. VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

Modificar um cluster de um projeto obsoleto

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 role de proprietĆ”rio do projeto. Para todas as outras atualizaƧƵes, a chave de API solicitante deve ter a role 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. VersƵes antigas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+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.

diskSizeGB
nĆŗmero <double> [ 10 ... 4096 ]

Capacidade de armazenamento que o volume raiz do host tem expressada em gigabytes. Aumente esse nĆŗmero para aumentar a capacidade. 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 atualizar 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

Configure este 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 sharding gerenciado pelo Atlas. Esse modo gerencia totalmente a fragmentaĆ§Ć£o do seu cluster global e Ć© criado para fornecer uma experiĆŖncia de implantaĆ§Ć£o contĆ­nua.

Quando definido como true, o modo de gerenciamento Ć© definido como fragmentaĆ§Ć£o autogerenciada. Esse modo deixa o gerenciamento de shards em suas mĆ£os e foi criado para fornecer uma experiĆŖncia de sistema avanƧada e flexĆ­vel.

Esta 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
PadrĆ£o: "7.0"
Enum: "4.2" "4.4" "5.0" "6.0" "7.0"

VersĆ£o MongoDB principal do cluster. O MongoDB Cloud implementa o cluster com a versĆ£o estĆ”vel mais recente da versĆ£o especificada.

name
string [ 1 ... 64 ] caracteres ^[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
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 (MarcaĆ§Ć£o do recurso)

Lista que contƩm pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster.

Tags de recursos
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.2",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

Retornar opƧƵes de configuraĆ§Ć£o avanƧadas para um cluster obsoleto

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 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 obsoleto

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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Detalhes de configuraĆ§Ć£o avanƧados para adicionar a um cluster no projeto especificado.

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'.
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 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

Flag que indica se o cluster permite a execuĆ§Ć£o de operaƧƵes que realizam execuƧƵes em JavaScript no lado do servidor.

Esta opĆ§Ć£o corresponde Ć  modificaĆ§Ć£o do parĆ¢metro `security.javascriptEnabled` opĆ§Ć£o de arquivo de configuraĆ§Ć£o 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 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 role de gerenciador de cluster de projeto. VersƵes antigas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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-]*$

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

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

MĆ©tricas de nĆ­vel de coleĆ§Ć£o

Retorna, adiciona e edita namespaces fixados para o cluster ou processo especificado. TambĆ©m retorna dados de mĆ©trica de latĆŖncia no nĆ­vel da collection.

Retornar namespaces fixados

Retorna uma lista de namespaces fixados do cluster fornecido, um conjunto de namespaces selecionados manualmente pelos usuĆ”rios para coletar mĆ©tricas de latĆŖncia de query.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster para o qual recuperar namespaces fixados.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

Adicionar namespaces fixados

Adicionar a lista fornecida de namespaces Ć  lista de namespaces fixados existente para a coleta de mĆ©tricas de latĆŖncia em nĆ­vel de coleĆ§Ć£o para o grupo e cluster fornecidos

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster ao qual fixar os namespaces.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

Solicitar esquema de corpo: application/vnd.atlas.2023-11-15+json

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e nome da coleĆ§Ć£o) para fixar a coleĆ§Ć£o de mĆ©tricas de latĆŖncia de query.

namespaces
Array de strings Ćŗnico

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e collection) no host ou cluster especificado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

Pin Namespaces

O Pin forneceu a lista de namespaces para a coleĆ§Ć£o de mĆ©tricas de latĆŖncia em nĆ­vel de coleĆ§Ć£o para o Grupo e Cluster fornecidos. Isso inicializa uma lista de namespaces fixados ou substitui qualquer lista de namespaces fixados existente para o Grupo e o Cluster.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster ao qual fixar os namespaces.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

Solicitar esquema de corpo: application/vnd.atlas.2023-11-15+json

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e nome da coleĆ§Ć£o) para fixar a coleĆ§Ć£o de mĆ©tricas de latĆŖncia de query.

namespaces
Array de strings Ćŗnico

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e collection) no host ou cluster especificado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

Desafixar namespaces

Solte a lista fornecida de namespaces para a coleĆ§Ć£o de mĆ©tricas de latĆŖncia em nĆ­vel de coleĆ§Ć£o para o grupo e cluster fornecidos

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster do qual desafixar namespaces.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

Solicitar esquema de corpo: application/vnd.atlas.2023-11-15+json

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e nome da coleĆ§Ć£o) para fixar a coleĆ§Ć£o de mĆ©tricas de latĆŖncia de query.

namespaces
Array de strings Ćŗnico

Lista de strings de namespace (combinaĆ§Ć£o de banco de dados e collection) no host ou cluster especificado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

Retornar namespaces classificados de um cluster

Retorne o subconjunto de namespaces do cluster fornecido classificado pelo tempo de execuĆ§Ć£o total mais alto (descendente) dentro da janela de tempo fornecida.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster ao qual fixar os namespaces.

clusterView
necessƔrio
string
Enum: "primƔrio" "secondary" "INDIVIDUAL_PROCESS"

RĆ³tulo legĆ­vel por humanos que identifica a topologia do cluster para a qual recuperar as mĆ©tricas.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

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.

fim
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.

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.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "string",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

Retornar latĆŖncia de query em nĆ­vel de cluster

Obtenha uma lista das mediƧƵes em nƭvel de cluster do Coll Stats Latency para o namespace fornecido.

AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por humanos que identifica o cluster para o qual recuperar as mĆ©tricas.

clusterView
necessƔrio
string
Enum: "primƔrio" "secondary" "INDIVIDUAL_PROCESS"

RĆ³tulo legĆ­vel por humanos que identifica a topologia do cluster para a qual recuperar as mĆ©tricas.

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.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
Array de strings Ćŗnico
Itens Enum: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

Lista que contĆ©m as mĆ©tricas que vocĆŖ deseja recuperar para a sĆ©rie de dados associada. Se vocĆŖ nĆ£o definir esse parĆ¢metro, o recurso retornarĆ” uma sĆ©rie de dados para todas as mĆ©tricas de LatĆŖncia do EstatĆ­sticas da Coll.

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.

fim
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.

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.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "clusterView": "string",
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

Retornar todos os nomes de mƩtrica

Retorna todos os nomes de mĆ©tricas Coll Stats Latency disponĆ­veis e suas respectivas unidades para o projeto especificado no momento da solicitaĆ§Ć£o.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{ }

Retornar namespaces classificados de um host

Retorne o subconjunto de namespaces do processo fornecido classificado pelo maior tempo de execuĆ§Ć£o total (decrescente) dentro da janela de tempo fornecida.

AutorizaƧƵes:
DigestAuth
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: 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.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

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.

fim
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.

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.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "string",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

Retornar latĆŖncia de query em nĆ­vel de host

Obtenha uma lista das mediƧƵes em nƭvel de processo do Coll Stats Latency para o namespace fornecido

AutorizaƧƵes:
DigestAuth
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: 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.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
Array de strings Ćŗnico
Itens Enum: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE"

Lista que contĆ©m as mĆ©tricas que vocĆŖ deseja recuperar para a sĆ©rie de dados associada. Se vocĆŖ nĆ£o definir esse parĆ¢metro, o recurso retornarĆ” uma sĆ©rie de dados para todas as mĆ©tricas de LatĆŖncia do EstatĆ­sticas da Coll.

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.

fim
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.

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.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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) Ćŗnico

Lista das funƧƵes incorporadas que esta funĆ§Ć£o personalizada herda.

roleName
necessƔrio
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "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:
DigestAuth
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^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

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

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:
DigestAuth
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^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "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:
DigestAuth
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^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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) Ćŗnico

Lista das funƧƵes incorporadas que esta funĆ§Ć£o personalizada herda.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

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

objeto (Fornecedor de cloud do Data Lake)

Fornecedor de nuvem vinculado a este data lake.

objeto (DataLakeDataProcessRegion)

InformaƧƵes sobre a regiĆ£o do fornecedor de nuvem para a qual o data lake encaminha as conexƵes do cliente.

name
string

RĆ³tulo legĆ­vel por humanos que identifica o data lake.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

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

objeto (Fornecedor de cloud do Data Lake)

Fornecedor de nuvem vinculado a este data lake.

objeto (DataLakeDataProcessRegion)

InformaƧƵes sobre a regiĆ£o do fornecedor de nuvem para a qual o data lake encaminha as conexƵes do cliente.

name
string

RĆ³tulo legĆ­vel por humanos que identifica o data lake.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "overrunPolicy": "BLOCK",
  • "value": 0
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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 de 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: aplicativo/vnd.atlas.YYYY-MM-DD+gzip".

AutorizaƧƵes:
DigestAuth
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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

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

comentƔrio
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 endpoint VPC do cliente.

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.
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 para humanos para identificar a regiĆ£o do endpoint VPC do cliente.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "region": "string",
  • "type": "DATA_LAKE"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "region": "string",
  • "type": "DATA_LAKE"
}

Pipelines do Data Lake

Retorna, adiciona, edita e remove Atlas Data Lake Pipelines e execuƧƵes associadas.

Retornar todos os pipelines do Data Lake de um projeto

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Criar um pipeline de Data Lake

Cria um pipeline de data lake.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Remover uma pipeline do Data Lake

Remove um pipeline do Data Lake.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{ }

Retornar uma pipeline do Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Atualizar um pipeline do Data Lake

Atualiza um Data Lake Pipeline.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Retornar os agendamentos de ingestĆ£o disponĆ­veis para uma pipeline do Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Retornar snapshots de backup disponĆ­veis para um pipeline de Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Pausar uma pipeline do Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Retomar um pipeline de Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Retornar todas as execuƧƵes do pipeline do Data Lake de um projeto

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Excluir conjunto de dados de execuĆ§Ć£o da pipeline

Exclui o conjunto de dados gerado pelo Atlas durante a execuĆ§Ć£o do pipeline especificado.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{ }

Retornar uma execuĆ§Ć£o da pipeline do Data Lake

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

Acionar a ingestĆ£o de snapshots sob demanda

Aciona uma ingestĆ£o do Data Lake Pipeline de um snapshot especificado.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 o AWS IAM, x.509, LDAP ou OIDC Workload desse valor deve 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).

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"

Etiqueta legĆ­vel para humanos que indica se o novo usuĆ”rio ou grupo do banco de dados se autentica com a autenticaĆ§Ć£o federada do 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, MongoDB Atlas Data Lakes e InstĆ¢ncias de Streams do MongoDB Atlas que esse utilizador de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao utilizador de banco de dados acesso a todos os clusters, MongoDB Atlas Data Lakes e InstĆ¢ncias de Streams 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
ForƧa de trabalho da OIDC oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido pelo nome do grupo IdP
Volume de trabalho do OIDC oidcAuthType USUƁRIO ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo

AWS AutenticaĆ§Ć£o do IAM

{
  • "awsIAMType": "USER",
  • "databaseName": "$external",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "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:
DigestAuth
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 o AWS IAM, x.509, LDAP ou OIDC Workload desse valor deve 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
ForƧa de trabalho da OIDC oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido pelo nome do grupo IdP
Volume de trabalho do OIDC oidcAuthType USUƁRIO ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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 o AWS IAM, x.509, LDAP ou OIDC Workload desse valor deve 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
ForƧa de trabalho da OIDC oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido pelo nome do grupo IdP
Volume de trabalho do OIDC oidcAuthType USUƁRIO ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "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:
DigestAuth
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 o AWS IAM, x.509, LDAP ou OIDC Workload desse valor deve 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
ForƧa de trabalho da OIDC oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido pelo nome do grupo IdP
Volume de trabalho do OIDC oidcAuthType USUƁRIO ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 o AWS IAM, x.509, LDAP ou OIDC Workload desse valor deve 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).

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"

Etiqueta legĆ­vel para humanos que indica se o novo usuĆ”rio ou grupo do banco de dados se autentica com a autenticaĆ§Ć£o federada do 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, MongoDB Atlas Data Lakes e InstĆ¢ncias de Streams do MongoDB Atlas que esse utilizador de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao utilizador de banco de dados acesso a todos os clusters, MongoDB Atlas Data Lakes e InstĆ¢ncias de Streams 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
ForƧa de trabalho da OIDC oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido pelo nome do grupo IdP
Volume de trabalho do OIDC oidcAuthType USUƁRIO ID OIDC do Atlas (encontrado nas configuraƧƵes de federaĆ§Ć£o), seguido por uma "/", seguido 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "oidcAuthType": "NONE",
  • "password": "stringst",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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).

Cofre de chaves do Azure
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

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:
DigestAuth
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[ itens [ 1 ... 64 ] caracteres ^[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 eventos de usuĆ”rio de API (objeto) ou Tipos de eventos de conta de serviƧo (objeto) ou Tipos de eventos de App Services (objeto) ou Tipos de eventos de indexaĆ§Ć£o automĆ”tica (objeto) ou Tipos de eventos de configuraĆ§Ć£o de automaĆ§Ć£o (objeto) ou Tipos de auditoria AWS Peer Vpc (objeto) ou Tipos de auditoria Azure Peer Network (objeto) ou Tipos de eventos de cobranƧa (objeto) ou Tipos de auditoria de conexĆ£o de cluster (objeto) ou Tipos de eventos cluster (objeto) ou Tipos de eventos de backup Cps (objeto ) ou Tipos de eventos acessados pelo Data Explorer (objeto) ou Tipos de eventos da PolĆ­tica de compliance de backup do CPS (objeto) ou Tipos de eventos de backup de 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 Vpc de emparelhamento 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 ConstruĆ§Ć£o de Ć­ndice Tipos de auditoria (objeto) ou Tipos de auditoria NDS (objeto) ou VerificaĆ§Ć£o do banco de dados NDS Tipos t (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 de janela de manutenĆ§Ć£o NDS (objeto) ou Tipos de auditoria de dimensionamento automĆ”tico sem servidor (objeto) ou Tipos de auditoria de instĆ¢ncia sem servidor 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 conexĆ£o NDS (objeto) ou Tipos de evento de autenticaĆ§Ć£o de usuĆ”rio NDS x509 (objeto) ou Tipos de eventos de Online Archive (objeto) ou Tipos de auditoria de link privado (objeto) ou Tipos de eventos de operaĆ§Ć£o proativa (objeto) ou Tipos de eventos ReplicaSet (objeto) ou Tipos de auditoria de implantaĆ§Ć£o sem servidor (objeto) ou Tipos de eventos sem servidor (objeto) ou ConfiguraĆ§Ć£o de tipos de auditoria sem servidor (objeto) ou Tipos de eventos de fluxos (objeto) ou Tipos de eventos do processador de fluxo (objeto) ou Tipos de eventos de caso de suporte (objeto) ou Tipos de eventos de suporte (objeto) ou Tipos de eventos de equipe (objeto) ou Tipos de eventos de backup de locatĆ”rio (objeto) ou Tipos de eventos de usuĆ”rio (objeto) ou Tipos de auditoria de versĆ£o (objeto) ou Evento de recurso Tipos (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 eventos de usuĆ”rio de API (objeto) ou Tipos de eventos de conta de serviƧo (objeto) ou Tipos de eventos de App Services (objeto) ou Tipos de eventos de indexaĆ§Ć£o automĆ”tica (objeto) ou Tipos de eventos de configuraĆ§Ć£o de automaĆ§Ć£o (objeto) ou Tipos de auditoria AWS Peer Vpc (objeto) ou Tipos de auditoria Azure Peer Network (objeto) ou Tipos de eventos de cobranƧa (objeto) ou Tipos de auditoria de conexĆ£o de cluster (objeto) ou Tipos de eventos cluster (objeto) ou Tipos de eventos de backup Cps (objeto ) ou Tipos de eventos acessados pelo Data Explorer (objeto) ou Tipos de eventos da PolĆ­tica de compliance de backup do CPS (objeto) ou Tipos de eventos de backup de 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 Vpc de emparelhamento 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 ConstruĆ§Ć£o de Ć­ndice Tipos de auditoria (objeto) ou Tipos de auditoria NDS (objeto) ou VerificaĆ§Ć£o do banco de dados NDS Tipos t (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 de janela de manutenĆ§Ć£o NDS (objeto) ou Tipos de auditoria de dimensionamento automĆ”tico sem servidor (objeto) ou Tipos de auditoria de instĆ¢ncia sem servidor 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 conexĆ£o NDS (objeto) ou Tipos de evento de autenticaĆ§Ć£o de usuĆ”rio NDS x509 (objeto) ou Tipos de eventos de Online Archive (objeto) ou Tipos de auditoria de link privado (objeto) ou Tipos de eventos de operaĆ§Ć£o proativa (objeto) ou Tipos de eventos ReplicaSet (objeto) ou Tipos de auditoria de implantaĆ§Ć£o sem servidor (objeto) ou Tipos de eventos sem servidor (objeto) ou ConfiguraĆ§Ć£o de tipos de auditoria sem servidor (objeto) ou Tipos de eventos de fluxos (objeto) ou Tipos de eventos do processador de fluxo (objeto) ou Tipos de eventos de caso de suporte (objeto) ou Tipos de eventos de suporte (objeto) ou Tipos de eventos de equipe (objeto) ou Tipos de eventos de backup de locatĆ”rio (objeto) ou Tipos de eventos de usuĆ”rio (objeto) ou Tipos de auditoria de versĆ£o (objeto) ou Evento de recurso Tipos (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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "AUTO_INDEXING_ENABLED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "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:
DigestAuth
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 eventos de usuĆ”rio de API (objeto) ou Tipos de eventos de conta de serviƧo (objeto) ou Tipos de eventos de cobranƧa (objeto) ou Tipos de eventos 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 NDS (objeto) ou Tipos de eventos organizacionais (objeto) ou Tipos de eventos de parceiro (objeto) ou Tipos de eventos de suporte (objeto) ou Tipos de eventos de equipe (objeto) ou Tipos de eventos de usuĆ”rio (objeto ) ou Tipos de eventos de recurso (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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "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 da 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:
DigestAuth
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

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

A configuraĆ§Ć£o da organizaĆ§Ć£o conectada que vocĆŖ deseja atualizar.

dataAccessIdentityProviderIds
Array de strings Ćŗnico [ 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 Ćŗnico

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})$

Legacy 20- string de dĆ­gitos hexadecimais que identifica o fornecedor de identidade de acesso Ć  UI Ć  qual essa configuraĆ§Ć£o de organizaĆ§Ć£o conectada estĆ” associada. Esse ID pode ser encontrado na aba Console de gerenciamento de federaĆ§Ć£o > Fornecedores de identidade clicando no Ć­cone de informaƧƵes na linha ID do IdP de um fornecedor de identidade configurado.

postAuthRoleGrants
Array de strings Ćŗnico
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) Ćŗnico

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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) Ćŗnico

Roles do Atlas e os identificadores exclusivos dos grupos e organizaƧƵes associados a cada role.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

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:
DigestAuth
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

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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) Ćŗnico

Roles do Atlas e os identificadores exclusivos dos grupos e organizaƧƵes associados a cada role.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

Retornar todos os fornecedores 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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Criar um provedor de identidade

Cria um fornecedor de identidade dentro 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.

Nota: esse recurso Ć© compatĆ­vel apenas com a criaĆ§Ć£o de fornecedores de identidade OIDC.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-11-15+json

O fornecedor de identidade que vocĆŖ deseja criar.

Um dos
associatedDomains
Array de strings Ćŗnico

Lista que contƩm os domƭnios associados ao provedor de identidade.

PĆŗblico
string

Identificador do destinatƔrio pretendido do token.

authorizedType
string
Enum: "GROUP" "USUƁRIO"

Indica se a autorizaĆ§Ć£o Ć© concedida com base na associaĆ§Ć£o ao grupo ou no ID do usuĆ”rio.

clientId
string

Identificador do cliente atribuĆ­do a um aplicativo pelo fornecedor de identidade.

DescriĆ§Ć£o
string

A descriĆ§Ć£o do provedor de identidade.

displayName
string [ 1 .. 50 ] caracteres

RĆ³tulo legĆ­vel por humanos que identifica o provedor de identidade.

groupsClaim
string

Identificador da declaraĆ§Ć£o que contĆ©m IDs do Grupo de IdP no token.

idpType
string
Enum: "WORKFORCE" "WORKLOAD"

Enum de string que indica o tipo do provedor de identidade. O padrĆ£o Ć© WORKFORCE.

issuerUri
string

String exclusiva que identifica o emissor da SAML Assertion ou metadados OIDC/URL do documento de descoberta.

protocolo
string

O protocolo do provedor de identidade. SAML ou OIDC.

requestedScopes
Array de strings

Escopos que os aplicativos MongoDB solicitarĆ£o no endpoint de autorizaĆ§Ć£o.

userClaim
string

Identificador da declaraĆ§Ć£o que contĆ©m o ID do usuĆ”rio no token.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
Exemplo
{
  • "associatedDomains": [
    ],
  • "audience": "string",
  • "authorizationType": "GROUP",
  • "clientId": "string",
  • "description": "string",
  • "displayName": "string",
  • "groupsClaim": "string",
  • "idpType": "WORKFORCE",
  • "issuerUri": "urn:idp:default",
  • "protocol": "string",
  • "requestedScopes": [
    ],
  • "userClaim": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
Exemplo
{
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audience": "string",
  • "authorizationType": "GROUP",
  • "clientId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "groupsClaim": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "protocol": "string",
  • "requestedScopes": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userClaim": "string"
}

Excluir um fornecedor de identidade

Exclui um fornecedor de identidade na 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.

Aviso: as solicitaƧƵes para este recurso falharĆ£o se o fornecedor de identidade tiver organizaƧƵes conectadas. Antes de excluir um fornecedor de identidade, desconecte todas as organizaƧƵes e confirme que nenhuma organizaĆ§Ć£o em sua conta utiliza este fornecedor de identidade. Para saber mais, consulte Gerenciar mapeamento da organizaĆ§Ć£o para a autenticaĆ§Ć£o federada.

AutorizaƧƵes:
DigestAuth
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
Exemplo: 32b6e34b3d91647abb20e7b8

String Ćŗnica de 24 dĆ­gitos hexadecimais que identifica o fornecedor de identidade a ser conectado.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
{
  • "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 fornecedor de identidade por ID

Retorna um fornecedor de identidade na federaĆ§Ć£o especificada pelo ID do fornecedor de identidade. 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. VersƵes antigas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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
Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva que identifica o provedor de identidade a ser conectado. Se estiver usando uma versĆ£o da API anterior a 11-15-2023, use o ID legado 20-hexadecimal. Esse ID pode ser encontrado na aba Console de gerenciamento de federaĆ§Ć£o > Fornecedores de identidade clicando no Ć­cone de informaƧƵes na linha ID do IdP de um fornecedor de identidade configurado. Para todas as outras versƵes, use o 24-ID de dĆ­gito hexadecimal.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-11-15+json
Exemplo
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Atualizar um fornecedor de identidade

Atualiza um provedor de identidade na 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.

Aviso: alterar tipos de autorizaĆ§Ć£o e/ou atualizar declaraƧƵes de autorizaĆ§Ć£o pode impedir que usuĆ”rios e/ou grupos atuais acessem o banco de dados. VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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
Exemplo: 32b6e34b3d91647abb20e7b8

String exclusiva que identifica o provedor de identidade a ser conectado. Se estiver usando uma versĆ£o da API anterior a 11-15-2023, use o ID legado 20-hexadecimal. Esse ID pode ser encontrado na aba Console de gerenciamento de federaĆ§Ć£o > Fornecedores de identidade clicando no Ć­cone de informaƧƵes na linha ID do IdP de um fornecedor de identidade configurado. Para todas as outras versƵes, use o 24-ID de dĆ­gito hexadecimal.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

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

Solicitar esquema de corpo: application/vnd.atlas.2023-11-15+json

O fornecedor de identidade que vocĆŖ deseja atualizar.

Um dos
associatedDomains
Array de strings Ćŗnico

Lista que contƩm os domƭnios associados ao provedor de identidade.

DescriĆ§Ć£o
string

A descriĆ§Ć£o do provedor de identidade.

displayName
string [ 1 .. 50 ] caracteres

RĆ³tulo legĆ­vel por humanos que identifica o provedor de identidade.

idpType
string
Enum: "WORKFORCE" "WORKLOAD"

Enum de string que indica o tipo do provedor de identidade. O padrĆ£o Ć© WORKFORCE.

issuerUri
string

String exclusiva que identifica o emissor da SAML Assertion ou metadados OIDC/URL do documento de descoberta.

objeto (PemFileInfoUpdate)

InformaƧƵes do arquivo PEM para os certificados vigentes do provedor de identidade.

protocolo
string

O protocolo do provedor de identidade. SAML ou OIDC.

requestBinding
string
Enum: "HTTP-POST" "HTTP-REDIRECT"

VinculaĆ§Ć£o de mĆ©todo HTTP de Protocolo de SolicitaĆ§Ć£o de AutenticaĆ§Ć£o SAML (POST ou REDIRECT) que a autenticaĆ§Ć£o federada usa para enviar a solicitaĆ§Ć£o de autenticaĆ§Ć£o.

responseSignatureAlgorithm
string
Enum: "SHA-1" "SHA-256"

Algoritmo de assinatura que a autenticaĆ§Ć£o federada usa para criptografar a assinatura do provedor de identidade.

slug
string

URL de SSO personalizada para o provedor de identidade.

ssoDebugEnabled
necessƔrio
booleano

Sinalizador que indica se o fornecedor de identidade tem a depuraĆ§Ć£o de SSO habilitada.

ssoUrl
string

URL que aponta para o receptor da solicitaĆ§Ć£o de autenticaĆ§Ć£o SAML.

Status
string
Enum: "ACTIVE" "INACTIVE"

Enum de string que indica se o provedor de identidade estĆ” ativo.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
Exemplo
{
  • "associatedDomains": [
    ],
  • "description": "string",
  • "displayName": "string",
  • "idpType": "WORKFORCE",
  • "issuerUri": "urn:idp:default",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "https://example.com",
  • "status": "ACTIVE"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-11-15+json
Exemplo
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Revogar o JWKS de um fornecedor de identidade da OIDC

Revoga os tokens JWKS do fornecedor de identidade solicitado da OIDC. 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.

Aviso: a revogaĆ§Ć£o dos tokens JWKS atualiza imediatamente as chaves pĆŗblicas do IdP de todos os clusters do Atlas, invalidando os tokens de acesso assinados anteriormente e fazendo o logout de todos os usuĆ”rios. Talvez seja necessĆ”rio reiniciar seus clientes MongoDB. Todas as organizaƧƵes conectadas ao fornecedor de identidade serĆ£o afetadas. Para saber mais, consulte Configurar a autorizaĆ§Ć£o do OIDC.

AutorizaƧƵes:
DigestAuth
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
Exemplo: 32b6e34b3d91647abb20e7b8

String Ćŗnica de 24 dĆ­gitos hexadecimais que identifica o fornecedor de identidade a ser conectado.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
{
  • "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 os metadados de um fornecedor 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:
DigestAuth
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

Legacy 20-string de dĆ­gitos hexadecimais que identifica o provedor de identidade. Esse ID pode ser encontrado na aba Console de gerenciamento de federaĆ§Ć£o > Fornecedores de identidade clicando no Ć­cone de informaƧƵes na linha ID do IdP de um fornecedor de identidade configurado.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "federatedDomains": [
    ],
  • "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 um namespace gerenciado em um cluster global

Retorna um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma collection utilizando o nome do banco de dados, o separador de pontos e o nome da collection. Para usar esse recurso, a chave de API solicitante deve ter a role de somente leitura do projeto. VersƵes antigas: v2-{2023-01-01}

Global Clusters
AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

Remover todos os mapeamentos de zona personalizada 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 solicitada deve ter a role de ProprietĆ”rio do projeto. VersƵes antigas: v2-{2023-01-01}

Global Clusters
AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

Adicionar uma entrada a um mapeamento de zona personalizado

Cria um mapeamento de zona personalizado 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. 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 role de proprietĆ”rio do projeto. VersƵes antigas: v2-{2023-01-01}

Global Clusters
AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMappings": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

Remover 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 a dados do projeto". VersƵes obsoletas: v2-{2023-01-01}

Global Clusters
AutorizaƧƵes:
DigestAuth
parĆ¢metros de caminho
clusterName
necessƔrio
string [ 1 ... 64 ] caracteres ^[a-zA-Z0-9][a-zA-Z0-9-]*$

RĆ³tulo legĆ­vel por 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.

banco de dados
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

Criar um namespace gerenciado em um cluster global

Cria um namespace gerenciado dentro do cluster global especificado. Um namespace gerenciado identifica uma collection utilizando o nome do banco de dados, o separador de pontos e o nome da collection. Para usar esse recurso, a chave de API solicitante deve ter a role de Administrador de acesso a dados do projeto. VersƵes antigas: v2-{2023-01-01}

Global Clusters
AutorizaƧƵes:
DigestAuth
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-]*$

RĆ³tulo legĆ­vel por 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Namespace gerenciado a ser criado dentro do cluster global especificado.

collection
string

RĆ³tulo legĆ­vel por humanos da coleĆ§Ć£o a ser gerenciada para esse cluster global.

customShardKey
string

ParĆ¢metro do banco de dados utilizado para dividir a coleĆ§Ć£o em fragmentos. Clusters globais exigem uma chave de shard composta. Essa chave de shard composta combina o parĆ¢metro de localizaĆ§Ć£o e a chave personalizada selecionada pelo usuĆ”rio.

banco de dados
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 de shard personalizada. Se esse parĆ¢metro retornar false, esse cluster usarĆ” fragmentaĆ§Ć£o Ć  distĆ¢ncia.

isShardKeyUnique
booleano
PadrĆ£o: false

Sinalizador que indica se o Ć­ndice subjacente forƧa valores Ćŗnicos.

numInitialChunks
inteiro <int64>

NĆŗmero mĆ­nimo de chunks a serem criados inicialmente ao fragmentar uma collection vazia com uma hashed shard key.

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.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "collection": "string",
  • "customShardKey": "string",
  • "db": "string",
  • "isCustomShardKeyHashed": false,
  • "isShardKeyUnique": false,
  • "numInitialChunks": 0,
  • "presplitHashedZones": false
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

Faturas

Retorna faturas.

Criar processo de consulta do Cost Explorer

Cria um processo de query dentro do Visualizador de custos para os parĆ¢metros fornecidos. Ɖ retornado um token que pode ser usado para pesquisar o status da query e, eventualmente, recuperar os resultados.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Filtrar parĆ¢metros para a consulta do Cost Explorer.

clusters
Array de strings

A lista de projetos a serem incluĆ­dos na query do Cost Explorer.

endDate
necessƔrio
string <date>

A data final exclusiva para a query do Cost Explorer. A data deve ser o inĆ­cio de um mĆŖs.

groupBy
string
Enum: "organizations" "projetos" "clusters" "services"

A dimensĆ£o pela qual agrupar os resultados de uso retornados. Pelo menos um valor de filtro precisa ser fornecido para que uma dimensĆ£o seja usada.

includePartialMatches
booleano

Sinalizador para controlar se o uso que corresponde aos critĆ©rios de filtro, mas que nĆ£o tem valores para todos os critĆ©rios de filtro, Ć© incluĆ­do na resposta. O padrĆ£o Ć© falso, o que exclui os dados parcialmente correspondentes.

organizaƧƵes
Array de strings

A lista de organizaƧƵes a serem incluƭdas na consulta do Cost Explorer.

projects
Array de strings

A lista de projetos a serem incluĆ­dos na query do Cost Explorer.

ServiƧos
Array de strings
Itens Enum: "atlas" "Clusters" "Storage" "InstĆ¢ncias sem servidor" "Backup" "Data Transfer" "BI Connector" "Premium Features" "Atlas Data Federation" "Atlas Stream Processing" "App Services" "Charts" "Cloud Manager" "Cloud Manager Standard/Premium" "Legacy Backup" "Flex Consulting" "Support" "CrĆ©ditos"

A lista de projetos a serem incluĆ­dos na query do Cost Explorer.

startDate
necessƔrio
string <date>

A data de inĆ­cio inclusiva da query do Visualizador de custos. A data deve ser o inĆ­cio de um mĆŖs.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusters": [
    ],
  • "endDate": "2022-02-01",
  • "groupBy": "organizations",
  • "includePartialMatches": true,
  • "organizations": [
    ],
  • "projects": [
    ],
  • "services": [
    ],
  • "startDate": "2022-02-01"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "token": "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71"
}

Retornar os resultados de uma determinada consulta do Cost Explorer ou notificar que os resultados ainda nĆ£o estĆ£o prontos.

Retorna os detalhes de uso de uma query do Cost Explorer, se a query for concluĆ­da e os dados estiverem prontos para serem exibidos. Se os dados nĆ£o estiverem prontos, uma resposta de "processamento" indicarĆ” que outra solicitaĆ§Ć£o deve ser enviada posteriormente para visualizar os dados.

AutorizaƧƵes:
DigestAuth
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.

sĆ­mbolo
necessƔrio
string = 64 caracteres
Exemplo: 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C

String Ćŗnica de 64 dĆ­gitos que identifica a query do Cost Explorer.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
Sem amostra

Retornar todas as faturas de uma organizaĆ§Ć£o

Retorna todas as faturas que a 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 CobranƧa da OrganizaĆ§Ć£o ou ProprietĆ”rio da OrganizaĆ§Ć£o. Se vocĆŖ tiver uma configuraĆ§Ć£o de organizaĆ§Ć£o cruzada, vocĆŖ pode visualizar as faturas vinculadas se 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 de cada fatura. 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 - beginBalanceCents.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

Retornar a fatura de uma organizaĆ§Ć£o

Retorna uma fatura que a MongoDB emitiu para a organizaĆ§Ć£o especificada. Uma string exclusiva de 24dĆ­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 CobranƧa 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 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 - beginBalanceCents.

AutorizaƧƵes:
DigestAuth
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

Tipo de conteĆŗdo
Sem amostra

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 exclusiva de 24dĆ­gitos hexadecimais que identifica a fatura. Para usar esse recurso, a chave de API solicitante dever ter pelo menos a role de visualizador de faturamento da organizaĆ§Ć£o, administrador de cobranƧa 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 role 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 - beginBalanceCents.

AutorizaƧƵes:
DigestAuth
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

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

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "completed": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "parts": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "checkpointId": "32b6e34b3d91647abb20e7b8",
  • "delivery": {
    },
  • "oplogInc": 1,
  • "oplogTs": "string",
  • "pointInTimeUTCMillis": 1199145600000,
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "batchId": "32b6e34b3d91647abb20e7b8",
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "delivery": {
    },
  • "encryptionEnabled": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hashes": [],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "statusName": "IN_PROGRESS",
  • "timestamp": {
    }
}

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

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:
DigestAuth
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

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "startASAP": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{ }

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:
DigestAuth
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

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:
DigestAuth
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

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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "country": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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 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 auditoria da infraestrutura de backend do cluster a cada cinco minutos e contĆ©m dados de log dos cinco minutos anteriores. Se vocĆŖ pesquisar arquivos de log na API, recomendamos a sondagem a cada cinco minutos. Por exemplo, se os logs forem atualizados em 4:00 UTC e entĆ£o vocĆŖ pesquisar a API, a API retornarĆ” dados de log do intervalo entre 3:55 UTC e 4:00 UTC . Esse recurso nĆ£o estĆ” disponĆ­vel para clusters M0 gratuitos, 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 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: aplicativo/vnd.atlas.YYYY-MM-DD+gzip". VersƵes obsoletas: v2-{2023-01-01}

AutorizaƧƵes:
DigestAuth
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

Data e hora em que o perĆ­odo especifica o ponto final inclusivo para o intervalo de mensagens de registro a serem recuperadas. Este parĆ¢metro expressa seu valor no nĆŗmero de segundos decorridos desde a UNIX epoch.

startDate
inteiro <int64> >= 1199145600

Data e hora em que o perĆ­odo especifica o ponto de inĆ­cio inclusivo para a faixa de mensagens de registro a serem recuperadas. Este parĆ¢metro expressa seu valor no 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 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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMetrics": [
    ],
  • "indexMetrics": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "statusMetrics": [
    ]
}

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:
DigestAuth
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.

fim
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 Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "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:
DigestAuth
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.

fim
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 Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "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:
DigestAuth
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.

fim
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 Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z",
  • "statusMeasurements": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "created": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostname": "string",
  • "id": "string",
  • "lastPing": "2019-08-24T14:15:22Z",
  • "links": [],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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 Ćŗnico
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.

fim
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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 Ćŗnico
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"

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.

fim
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "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:
DigestAuth
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 Ćŗnico
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" "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_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "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"

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.

fim
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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) nĆ£o vazia

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "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: aplicativo/vnd.atlas.YYYY-MM-DD+gzip".

Arquivo On-line
AutorizaƧƵes:
DigestAuth
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-]*$

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

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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "paused": true,
  • "schedule": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  • "organization": {}
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 Ćŗnico
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 Ćŗnico [ 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 Ćŗnico
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 Ćŗnico [ 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 Ćŗnico
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 Ćŗnico [ 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

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 determina se deve bloquear o acesso da equipe de suporte do MongoDB Ć  infraestrutura do Atlas de 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/.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{ }

Atualizar roles da organizaĆ§Ć£o para um usuĆ”rio do MongoDB Cloud

Atualiza as funƧƵes do usuĆ”rio especificado na organizaĆ§Ć£o especificada. Para especificar o usuĆ”rio a ser atualizado, forneƧa a string exclusiva de 24 dĆ­gitos hexadecimais que identifica o usuĆ”rio na 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:
DigestAuth
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 modificado.

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

FunƧƵes para atualizar para o usuƔrio especificado.

orgRoles
Array de strings Ćŗnico
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.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "orgRoles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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 Query Profiler 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:
DigestAuth
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
{
  • "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 Query Profiler 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:
DigestAuth
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
{
  • "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:
DigestAuth
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. Este parĆ¢metro expressa seu valor no nĆŗmero de milissegundos decorridos desde a UNIX epoch.

  • 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "namespaces": [
    ]
}

Retornar queries lentas

Retorna linhas de log para consultas lentas que o Performance Advisor e o Query Profiler 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:
DigestAuth
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. Este parĆ¢metro expressa seu valor no nĆŗmero de milissegundos decorridos desde a UNIX epoch.

  • 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "slowQueries": [
    ]
}

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:
DigestAuth
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. Este parĆ¢metro expressa seu valor no nĆŗmero de milissegundos decorridos desde a UNIX epoch.

  • 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "shapes": [
    ],
  • "suggestedIndexes": [
    ]
}

Retornar indexaĆ§Ć£o automĆ”tica sem servidor habilitada

Obtenha se o recurso de indexaĆ§Ć£o automĆ”tica sem servidor estĆ” habilitado.

AutorizaƧƵes:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
true

Definir indexaĆ§Ć£o automĆ”tica sem servidor

Defina se o recurso de indexaĆ§Ć£o automĆ”tica sem servidor estĆ” habilitado.

AutorizaƧƵes:
DigestAuth
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-]*$

Etiqueta legĆ­vel por humanos que identifica o cluster.

parĆ¢metros de query
habilitar
necessƔrio
booleano

Valor que queremos definir para a alternĆ¢ncia de indexaĆ§Ć£o automĆ”tica sem servidor.

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
application/vnd.atlas.2023-01-01+json
{ }

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 endpoint privado para o fornecedor de nuvem especificado. Esse fornecedor de nuvem managed o serviƧo de endpoint privado do projeto. Quando vocĆŖ cria um serviƧo de endpoint privado, o MongoDB Cloud cria um container de rede no projeto para o fornecedor de nuvem para o qual vocĆŖ cria o serviƧo de endpoint privado, se ainda nĆ£o existir um. Para saber mais sobre a terminologia de endpoint privado no MongoDB Cloud, consulte Conceitos de endpoint privado. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietĆ”rio do projeto.

Conceitos de endpoints privados
AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Crie um ponto de extremidade privado para o provedor de serviƧos de nuvem especificado.

providerName
necessƔrio
string
Enum: "AWS" "AZURE" "GCP"

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "providerName": "AWS",
  • "region": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Crie um ponto de extremidade privado para o provedor de serviƧos de nuvem especificado.

Um dos
objeto AWS Recursivo

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "id": "vpce-3bf78b0ddee411ba1"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 nĆ£o vazia
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 nĆ£o vazia
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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": []
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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.

comentƔrio
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "awsSecurityGroup": "string",
  • "cidrBlock": "string",
  • "comment": "string",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "ipAddress": "string",
  • "links": []
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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 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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Cria um projeto.

name
necessƔrio
string [ 1 ... 64 ] caracteres ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

RĆ³tulo 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, este campo serƔ rejeitado em solicitaƧƵes e 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 sistemas em regiƵes moderadas do FedRAMP.
GOV_REGIONS_ONLY Permite apenas implantaƧƵes em regiƵes GovCloud.
https://www.mongodb.com/pt-br/docs/atlas/domĆ­nio/overview/supported-regions/#supported-cloud-providers-and-regions
Array de objetos (MarcaĆ§Ć£o do recurso)

Lista que contƩm pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o projeto.

Tags de recursos
withDefaultAlertsSettings
booleano

Sinalizador que indica se vocĆŖ deve criar o projeto com as configuraƧƵes de alerta padrĆ£o.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ],
  • "withDefaultAlertsSettings": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

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:
DigestAuth
parĆ¢metros de caminho
groupName
necessƔrio
string [ 1 ... 64 ] caracteres

RĆ³tulo legĆ­vel para 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
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

Atualizar um projeto

Atualiza o rĆ³tulo legĆ­vel pelo ser humano que identifica o projeto especificado ou as marcaƧƵes associadas ao projeto. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietĆ”rio do projeto.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Projeto para atualizar.

name
string

RĆ³tulo legĆ­vel por humanos que identifica o projeto incluĆ­do na organizaĆ§Ć£o MongoDB Cloud.

Array de objetos (MarcaĆ§Ć£o do recurso)

Lista que contƩm pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o projeto.

Tags de recursos

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "tags": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

Adicionar um usuƔrio da nuvem MongoDB a um projeto

Adiciona um usuĆ”rio do MongoDB Cloud ao projeto especificado. Se o usuĆ”rio da MongoDB Cloud nĆ£o for membro da organizaĆ§Ć£o do projeto, o usuĆ”rio deverĆ” aceitar seu convite para acessar informaƧƵes dentro do projeto especificado. Se o MongoDB Cloud User jĆ” for membro da organizaĆ§Ć£o do projeto, ele serĆ” adicionado ao projeto imediatamente e um convite nĆ£o serĆ” retornado por esse recurso. Para usar esse recurso, a chave de API solicitante deve ter o role de administrador do usuĆ”rio do grupo.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Adiciona um usuƔrio do MongoDB Cloud ao projeto especificado.

roles
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

Devolver todos os convites de projetos Descontinuado

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Atualizar um convite de projeto Descontinuado

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Atualiza as informaƧƵes de um convite pendente para o projeto especificado.

roles
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

Convidar um usuƔrio do MongoDB Cloud para ingressar em um projeto Descontinuado

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Convidar um usuƔrio do MongoDB Cloud para participar do projeto especificado.

roles
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

Cancelar um convite de projeto Descontinuado

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{ }

Retornar um convite de projeto Descontinuado

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

Atualizar um convite de projeto por ID de convite Descontinuado

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Atualiza as informaƧƵes de um convite pendente para o projeto especificado.

roles
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

Retornar todos os endereƧos IP de um projeto

Retorna todos os endereƧos IP desse projeto. Para usar esse recurso, a chave da API solicitante deve ter a funĆ§Ć£o de Somente leitura do projeto.

AutorizaƧƵes:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "services": {
    }
}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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"

RĆ³tulo 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 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
groupId
necessƔrio
string = 24 caracteres ^([a-f0-9]{24})$
Exemplo: 32b6e34b3d91647abb20e7b8

SequĆŖncia Ćŗnica de 24 dĆ­gitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuĆ”rio autenticado tem acesso.

AVISO: grupos e projetos sĆ£o termos sinĆ“nimos. O ID do seu grupo Ć© igual ao ID 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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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"

RĆ³tulo 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 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
groupId
necessƔrio
string = 24 caracteres ^([a-f0-9]{24})$
Exemplo: 32b6e34b3d91647abb20e7b8

SequĆŖncia Ćŗnica de 24 dĆ­gitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuĆ”rio autenticado tem acesso.

AVISO: grupos e projetos sĆ£o termos sinĆ“nimos. O ID do seu grupo Ć© igual ao ID 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
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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"

RĆ³tulo 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 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
groupId
necessƔrio
string = 24 caracteres ^([a-f0-9]{24})$
Exemplo: 32b6e34b3d91647abb20e7b8

SequĆŖncia Ćŗnica de 24 dĆ­gitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuĆ”rio autenticado tem acesso.

AVISO: grupos e projetos sĆ£o termos sinĆ“nimos. O ID do seu grupo Ć© igual ao ID 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Limite para atualizaĆ§Ć£o.

valor
necessƔrio
inteiro <int64>

Valor da definiĆ§Ć£o do limite.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "value": 0,
  • "name": "atlas.project.deployment.clusters"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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
application/vnd.atlas.2023-01-01+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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

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 funƧƵes do projeto para um usuƔrio do MongoDB Cloud

Atualiza as funƧƵes do usuĆ”rio especificado no projeto especificado. Para especificar o usuĆ”rio que serĆ” atualizado, forneƧa a string exclusiva de 24 dĆ­gitos hexadecimais que identifica o usuĆ”rio no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a funĆ§Ć£o "Administrador de usuĆ”rio do grupo".

AutorizaƧƵes:
DigestAuth
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 24 dƭgitos hexadecimais que identifica o usuƔrio a ser modificado.

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

FunƧƵes para atualizar para o usuƔrio especificado.

groupRoles
Array de strings Ćŗnico
Itens Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

Uma ou mais funƧƵes de nƭvel de projeto a serem atribuƭdos ao usuƔrio do MongoDB Cloud.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "groupRoles": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

ExportaĆ§Ć£o de registros baseados em push

VocĆŖ pode enviar logs continuamente do mongod, mongos e logs de auditoria para um bucket do AWS S3 . O Atlas exporta registros a cada 5 minutos.

Desabilitar a funcionalidade de exportaĆ§Ć£o de log baseado em push para um projeto

Desativa o recurso de exportaĆ§Ć£o de log baseado em push redefinindo as configuraƧƵes do nĆ­vel do projeto para sua configuraĆ§Ć£o padrĆ£o.

AutorizaƧƵes:
DigestAuth
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
{
  • "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"
}

Obter a configuraĆ§Ć£o de exportaĆ§Ć£o de registro baseada em push de um projeto

Busca as configuraƧƵes atuais do nĆ­vel do projeto para o recurso de exportaĆ§Ć£o de log baseado em push.

AutorizaƧƵes:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "iamRoleId": "string",
  • "links": [],
  • "prefixPath": "string",
  • "state": "UNCONFIGURED"
}

Atualizar a funcionalidade de exportaĆ§Ć£o de registro baseado em push para um projeto

Atualiza as configuraƧƵes de nĆ­vel do projeto para o recurso de exportaĆ§Ć£o de log baseado em push.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Os detalhes de configuraĆ§Ć£o do projeto. O nome do bucket S3, ID de funĆ§Ć£o do IAM e campos de caminho de prefixo sĆ£o os Ćŗnicos campos que podem ser especificados. Os campos nĆ£o especificados nĆ£o serĆ£o modificados.

bucketName
string

O nome do bucket para o qual o agente enviarĆ” os logs.

iamRoleId
string

ID da funĆ§Ć£o AWS IAM que serĆ” usada para gravar no bloco S3.

prefixPath
string

DiretĆ³rio S3 no qual o vetor gravarĆ” para armazenar os logs. Uma string vazia indica o diretĆ³rio raiz.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "iamRoleId": "string",
  • "prefixPath": "string"
}

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

Habilitar o recurso de exportaĆ§Ć£o de registro baseado em push de um projeto

Configura as definiƧƵes de nĆ­vel do projeto para o recurso de exportaĆ§Ć£o de log baseado em push.

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Os detalhes de configuraĆ§Ć£o do projeto. Os campos nome do bucket do S3, ID do funĆ§Ć£o do IAM e caminho do prefixo sĆ£o obrigatĆ³rios.

bucketName
necessƔrio
string

O nome do bucket para o qual o agente enviarĆ” os logs.

iamRoleId
necessƔrio
string

ID da funĆ§Ć£o AWS IAM que serĆ” usada para gravar no bloco S3.

prefixPath
necessƔrio
string

DiretĆ³rio S3 no qual o vetor gravarĆ” para armazenar os logs. Uma string vazia indica o diretĆ³rio raiz.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "iamRoleId": "string",
  • "prefixPath": "string"
}

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

ƍ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 criaĆ§Ć£o do Ć­ndice dessa forma permite a criaĆ§Ć£o de Ć­ndices em um nĆ³ do conjunto de rĆ©plicas como um autĆ“nomo de cada vez, comeƧando pelos nĆ³s secundĆ”rios. A criaĆ§Ć£o de Ć­ndices 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:
DigestAuth
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-]*$

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

RĆ³tulo legĆ­vel por humanos da coleĆ§Ć£o para a qual o MongoDB Cloud cria um Ć­ndice.

banco de dados
necessƔrio
string

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo

2Ć­ndice dspere

{
  • "collation": {
    },
  • "collection": "accounts",
  • "db": "sample_airbnb",
  • "keys": [
    ],
  • "options": {
    }
}

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

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:
DigestAuth
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "appName": "MongoDB Atlas",
  • "build": "83be55e140f493c88e7f578aae96548dd881587b",
  • "links": [],
  • "throttling": true
}

Retornar todos os endereƧos IP do plano de controle

Retorna todos os endereƧos IP do plano de controle.

AutorizaƧƵes:
none
parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-11-15+json
{
  • "inbound": {
    },
  • "outbound": {
    }
}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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-]*$

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 (MarcaĆ§Ć£o 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "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:
DigestAuth
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-]*$

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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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 (MarcaĆ§Ć£o 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "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:
DigestAuth
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-]*$

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

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:
DigestAuth
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-]*$

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

InformaƧƵes sobre o ponto de extremidade privado a ser criado para a instĆ¢ncia sem servidor.

comentƔrio
string <= 80 caracteres

ComentƔrio legƭvel por humanos associado ao ponto de extremidade privado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "_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:
DigestAuth
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-]*$

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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-]*$

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "_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:
DigestAuth
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-]*$

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Objeto usado para atualizaĆ§Ć£o.

comentƔrio
string <= 80 caracteres

ComentƔrio legƭvel por humanos associado ao ponto de extremidade privado.

providerName
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica o provedor de nuvem do ponto de extremidade do locatĆ”rio

cloudProviderEndpointId
string^vpce-[0-9a-f]{17}$

String exclusiva que identifica a interface de rede do ponto de extremidade privado.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "comment": "string",
  • "providerName": "AWS",
  • "cloudProviderEndpointId": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "_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:
DigestAuth
parĆ¢metros de caminho
clusterName
necessƔrio
string [ 1 ... 64 ] caracteres ^[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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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}$

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
parĆ¢metros de caminho
clusterName
necessƔrio
string [ 1 ... 64 ] caracteres ^[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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
parĆ¢metros de caminho
clusterName
necessƔrio
string [ 1 ... 64 ] caracteres ^[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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
parĆ¢metros de caminho
clusterName
necessƔrio
string [ 1 ... 64 ] caracteres ^[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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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}$

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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-]*$

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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "scheduledTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

Fluxos

Retorna, adiciona, edita e remove instĆ¢ncias de fluxo. Esse recurso requer a ID do seu projeto.

Retornar todas as instĆ¢ncias de stream do projeto

Retorna todas as instĆ¢ncias de fluxo do projeto especificado.

AutorizaƧƵes:
DigestAuth
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.

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
application/vnd.atlas.2023-02-01+json
{}

Criar uma instĆ¢ncia de stream

Cria uma instĆ¢ncia de fluxo no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto, a role de proprietĆ”rio do projeto ou a role de proprietĆ”rio de Atlas Stream Processing .

AutorizaƧƵes:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Detalhes para criar uma instĆ¢ncia de fluxos no projeto especificado.

objeto (StreamsDataProcessRegion)

InformaƧƵes sobre a regiĆ£o do provedor de nuvem na qual o MongoDB Cloud processa o fluxo.

name
string

RĆ³tulo legĆ­vel por humanos que identifica a instĆ¢ncia de fluxo.

object or null (StreamConfig)

OpƧƵes de configuraĆ§Ć£o para uma instĆ¢ncia do Atlas Stream Processing.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "streamConfig": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{}

Excluir uma instĆ¢ncia de fluxo

Exclui uma instĆ¢ncia de fluxo no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto, a role de proprietĆ”rio do projeto ou a role de proprietĆ”rio de processamento do projeto stream.

AutorizaƧƵes:
DigestAuth
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 de fluxo a ser excluĆ­da.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-02-01+json
{ }

Retornar uma instĆ¢ncia de stream

Retorna os detalhes de uma instĆ¢ncia de fluxo dentro do projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter as funƧƵes de Acesso a dados do projeto, ProprietĆ”rio do projeto ou ProprietĆ”rio do processamento do fluxo de projetos.

AutorizaƧƵes:
DigestAuth
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 de fluxo 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.

includeConnections
booleano

Sinalizador que indica se as informaƧƵes de conexƵes devem ser incluĆ­das na instĆ¢ncia de fluxo.

Respostas

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{}

Atualizar uma instĆ¢ncia de transmissĆ£o

Atualize uma instĆ¢ncia de fluxo no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto, a role de proprietĆ”rio do projeto ou a role de proprietĆ”rio de processamento do projeto stream.

AutorizaƧƵes:
DigestAuth
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 de fluxo a 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Detalhes da nova regiĆ£o do processo de dados a serem atualizados na instĆ¢ncia de fluxo.

cloudProvider
necessƔrio
string
Enum: "AWS" "GCP" "AZURE" "TENANT" "SERVERLESS"

RĆ³tulo que identifica o provedor de serviƧos de nuvem onde o MongoDB Cloud executa o processamento de fluxo. Atualmente, esse parĆ¢metro Ć© compatĆ­vel apenas com AWS.

necessƔrio
ApiStreamsAWSRegionView (object) (BaseStreamsRegion)

Nome da regiĆ£o do provedor de nuvem hospedando o Atlas Stream Processing.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{
  • "cloudProvider": "AWS",
  • "region": "VIRGINIA_USA"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
{}

Baixar registros de auditoria para uma instĆ¢ncia de processamento do Atlas Stream

Baixa os registros de auditoria da instĆ¢ncia de Processamento de Fluxos do Atlas especificada. Por padrĆ£o, os registros cobrem perĆ­odos de 30 dias. Para usar esse recurso, a chave de API solicitante deve ter as funƧƵes de Acesso a dados do projeto, ProprietĆ”rio do projeto ou ProprietĆ”rio do processamento do fluxo de projetos. 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: aplicativo/vnd.atlas.YYYY-MM-DD+gzip".

AutorizaƧƵes:
DigestAuth
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 de fluxo.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
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 todas as conexƵes das instĆ¢ncias de stream

Retorna todas as conexƵes da instĆ¢ncia de fluxo para o projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter as roles de acesso a dados do projeto, role de proprietĆ”rio do projeto ou role de proprietĆ”rio de processamento do projeto stream.

AutorizaƧƵes:
DigestAuth
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 de fluxo.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-02-01+json
{}

Criar uma conexĆ£o

Cria uma conexĆ£o para uma instĆ¢ncia de fluxo no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role "ProprietĆ”rio do projeto" ou "ProprietĆ”rio do processamento do fluxo de projetos".

AutorizaƧƵes:
DigestAuth
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 de fluxo.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Detalhes para criar uma conexĆ£o para uma instĆ¢ncia de fluxos no projeto especificado.

name
string

Etiqueta legĆ­vel por humanos que identifica a conexĆ£o do stream. No caso do tipo Amostra, este Ć© o nome da fonte de amostra.

type
string

Tipo de conexĆ£o. Pode ser cluster ou Kafka.

clusterName
string

Nome do cluster configurado para esta conexĆ£o.

objeto (DBRoleToExecute)

O nome de uma funĆ§Ć£o de banco de dados integrado ou personalizado para conectar-se a um cluster do Atlas.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
Exemplo
{
  • "name": "string",
  • "type": "Cluster",
  • "clusterName": "string",
  • "dbRoleToExecute": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
Exemplo
{}

Excluir uma conexĆ£o de transmissĆ£o

Exclua uma conexĆ£o da instĆ¢ncia de fluxo especificada. Para usar esse recurso, a chave de API solicitante deve ter a role "ProprietĆ”rio do projeto" ou "ProprietĆ”rio do processamento do fluxo de projetos".

AutorizaƧƵes:
DigestAuth
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 de fluxo.

connectionName
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica a conexĆ£o de fluxo.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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
application/vnd.atlas.2023-02-01+json
{ }

Retornar uma conexĆ£o de transmissĆ£o

Retorna os detalhes de uma conexĆ£o de fluxo dentro da instĆ¢ncia de fluxo especificada. Para usar esse recurso, a chave da API solicitante deve ter a funĆ§Ć£o de Somente leitura do projeto.

AutorizaƧƵes:
DigestAuth
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 de fluxo a ser retornada.

connectionName
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica a conexĆ£o de fluxo para 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
Exemplo
{}

Atualizar uma conexĆ£o de stream

Atualize uma conexĆ£o para a instĆ¢ncia de fluxo especificada no projeto especificado. Para usar esse recurso, a chave de API solicitante deve ter a role "ProprietĆ”rio do projeto" ou "ProprietĆ”rio do processamento do fluxo de projetos".

AutorizaƧƵes:
DigestAuth
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 de fluxo.

connectionName
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica a conexĆ£o de fluxo.

parĆ¢metros de query
envelope
booleano
PadrĆ£o: false
Exemplo: envelope=false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API nĆ£o podem acessar os cabeƧalhos de resposta HTTP ou o cĆ³digo de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-02-01+json

Detalhes para atualizar uma conexĆ£o para uma instĆ¢ncia de fluxos no projeto especificado.

name
string

Etiqueta legĆ­vel por humanos que identifica a conexĆ£o do stream. No caso do tipo Amostra, este Ć© o nome da fonte de amostra.

type
string

Tipo de conexĆ£o. Pode ser cluster ou Kafka.

clusterName
string

Nome do cluster configurado para esta conexĆ£o.

objeto (DBRoleToExecute)

O nome de uma funĆ§Ć£o de banco de dados integrado ou personalizado para conectar-se a um cluster do Atlas.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
Exemplo
{
  • "name": "string",
  • "type": "Cluster",
  • "clusterName": "string",
  • "dbRoleToExecute": {
    }
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-02-01+json
Exemplo
{}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Equipe para adicionar ao projeto especificado.

Array
roleNames
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

As funƧƵes do projeto atribuƭdas Ơ equipe especificada.

roleNames
Array de strings Ćŗnico
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "roleNames": [
    ],
  • "teamId": "32b6e34b3d91647abb20e7b8"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Equipe que vocĆŖ deseja criar na organizaĆ§Ć£o especificada.

name
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica a equipe.

usernames
Array de strings <email> Ćŗnico

Lista que contƩm os usuƔrios do MongoDB Cloud nesta equipe.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "usernames": [
    ]
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+json

Detalhes para atualizar na equipe especificada.

name
necessƔrio
string

RĆ³tulo legĆ­vel por humanos que identifica a equipe.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "name": "string"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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"

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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"

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "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:
DigestAuth
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"

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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"

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

RĆ³tulo 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.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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"

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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"

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

RĆ³tulo 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.

Respostas

Solicitar amostras

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
Exemplo
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{}

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:
DigestAuth
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

RĆ³tulo 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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "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:
DigestAuth
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

RĆ³tulo 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.

Solicitar esquema de corpo: application/vnd.atlas.2023-01-01+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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "monthsUntilExpiration": 3
}

Exemplos de resposta

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+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:
DigestAuth
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

Tipo de conteĆŗdo
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}