Versão do recurso 2025-03-12
Baixar especificação OpenAPI:Baixar
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 contas de serviço OAuth2 ou 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.2025-03-12+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.
Você também pode explorar os vários endpoints disponíveis por meio da Administration API do Atlas no espaço de trabalho Postman do MongoDB.
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).
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 conta de serviço ou a chave de API solicitante deve ter a função de administrador do Project Monitoring ou a função de administrador do Project Database Access.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
| authResult | booleano Sinalizador que indica se a resposta retorna apenas as tentativas de autenticação bem-sucedidas. |
| end | inteiro <int64> Data e hora para parar de recuperar o histórico do banco de dados. Se você especificar o fim, você também deverá especificar o início. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
| ipAddress | string^(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... Um endereço de protocolo de internet que tentou autenticar com o banco de dados. |
| nLogs | inteiro <int32> [ 0 .. 20000 ] Padrão: 20000 Número máximo de linhas do registro a serem retornadas. |
| iniciar | inteiro <int64> Data e hora em que o MongoDB Cloud começa a recuperar o histórico do banco de dados. Se você especificar o início, também deverá especificar o fim. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
{- "accessLogs": [
- {
- "authResult": true,
- "authSource": "string",
- "failureReason": "string",
- "groupId": "string",
- "hostname": "string",
- "ipAddress": "string",
- "logLine": "string",
- "timestamp": "string",
- "username": "string"
}
]
}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 conta de serviço ou a chave de API solicitante deve ter a função de administrador do Project Monitoring ou a função de administrador do Project Database Access.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
| authResult | booleano Sinalizador que indica se a resposta retorna apenas as tentativas de autenticação bem-sucedidas. |
| end | inteiro <int64> Data e hora para parar de recuperar o histórico do banco de dados. Se você especificar o fim, você também deverá especificar o início. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
| ipAddress | string^(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... Um endereço de protocolo de internet que tentou autenticar com o banco de dados. |
| nLogs | inteiro <int32> [ 0 .. 20000 ] Padrão: 20000 Número máximo de linhas do registro a serem retornadas. |
| iniciar | inteiro <int64> Data e hora em que o MongoDB Cloud começa a recuperar o histórico do banco de dados. Se você especificar o início, também deverá especificar o fim. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
{- "accessLogs": [
- {
- "authResult": true,
- "authSource": "string",
- "failureReason": "string",
- "groupId": "string",
- "hostname": "string",
- "ipAddress": "string",
- "logLine": "string",
- "timestamp": "string",
- "username": "string"
}
]
}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 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.
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- "APPLICATION_ID"
]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 conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}Cria 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 conta de serviço ou a chave de API solicitante deve ter a role "Proprietário da organização" ou "Proprietário do projeto".
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Cria uma configuração de alerta para o projeto especificado.
| 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 eventos de proteção de dados (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 do Online Archive (objeto) ou Tipos de eventos do usuário (objeto) ou Tipos de eventos de recursos (objeto) ou Tipos de eventos do processador de fluxo (objeto) ou Tipos de auditoria de dimensionamento automático do NDS (objeto) ou Tipos de auditoria da Política de recursos do Atlas (objeto) Incidente que acionou este alerta. |
Array de objetos (Correspondentes) Condições correspondentes para recursos de destino. | |
necessário | Array de Notificação Datadog (objeto) ou Notificação por e-mail (objeto) ou Notificação de grupo (objeto) ou Notificação HipChat (objeto) ou Notificação do Microsoft Teams (objeto) ou Notificação OpsGenie (objeto) ou Notificação de organização (objeto) ou Notificação PagerDuty (objeto) ou Notificação do Slack (objeto) ou Notificação por SMS (objeto) ou Notificação de equipe (objeto) ou Notificação de usuário (objeto) ou Notificação VictorOps (objeto) ou Notificação Webhook (objeto) (AlertsNotificationRootForGroup) Lista que contém os destinos para o quais o MongoDB Cloud envia notificações. |
| severityOverride | string (EventSeverity) Enum: "INFO" "WARNING" "erro" "CRÍTICO" Gravidade do evento. |
{- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO"
}{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}Remove uma configuração de alerta do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "Proprietário da organização" ou "Proprietário do projeto". Use o endpoint Return All Alert Configurations for One Project para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24dígitos hexadecimais que identifica a configuração de alerta . |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}Retorna a configuração de alerta especificada do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Use o endpoint Return All Alert Configurations for One Project para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24dígitos hexadecimais que identifica a configuração de alerta . |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}Habilita ou desabilita a configuração de alerta especificada no projeto indicado. O recurso ativa a configuração de alerta especificada se estiver ativado no momento. O recurso desativa a configuração de alerta especificada se estiver desativada no momento. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String exclusiva de 24dígitos hexadecimais que identifica a configuração de alerta que acionou esse alerta. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. |
{- "enabled": true
}{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}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 conta de serviço ou a chave de API solicitante deve ter a role "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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24dígitos hexadecimais que identifica a configuração de alerta . |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Atualiza uma configuração de alerta no projeto especificado.
| 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 eventos de proteção de dados (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 do Online Archive (objeto) ou Tipos de eventos do usuário (objeto) ou Tipos de eventos de recursos (objeto) ou Tipos de eventos do processador de fluxo (objeto) ou Tipos de auditoria de dimensionamento automático do NDS (objeto) ou Tipos de auditoria da Política de recursos do Atlas (objeto) Incidente que acionou este alerta. |
Array de objetos (Correspondentes) Condições correspondentes para recursos de destino. | |
necessário | Array de Notificação Datadog (objeto) ou Notificação por e-mail (objeto) ou Notificação de grupo (objeto) ou Notificação HipChat (objeto) ou Notificação do Microsoft Teams (objeto) ou Notificação OpsGenie (objeto) ou Notificação de organização (objeto) ou Notificação PagerDuty (objeto) ou Notificação do Slack (objeto) ou Notificação por SMS (objeto) ou Notificação de equipe (objeto) ou Notificação de usuário (objeto) ou Notificação VictorOps (objeto) ou Notificação Webhook (objeto) (AlertsNotificationRootForGroup) Lista que contém os destinos para o quais o MongoDB Cloud envia notificações. |
| severityOverride | string (EventSeverity) Enum: "INFO" "WARNING" "erro" "CRÍTICO" Gravidade do evento. |
{- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO"
}{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}Retorna todas as configurações de alerta definidas para o alerta especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Use o endpoint Retornar todos os alertas de um projeto para recuperar todos os alertas aos quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Sequência única de 24dígitos hexadecimais que identifica o alerta. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
{- "results": [
- {
- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "severityOverride": "INFO",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}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.
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 acionadores e os métodos de notificação para alertas. Alertas abertos foram acionados, mas permanecem não reconhecidos. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Use o endpoint Return All Alert Configurations for One Project para recuperar todas as configurações de alerta às quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24dígitos hexadecimais que identifica a configuração de alerta . |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}Retorna todos os alertas. Esses alertas se aplicam a todos os componentes de um projeto. Você recebe um alerta quando um componente monitorado atinge ou excede um valor definido por você. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: 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. |
{- "results": [
- {
- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}Retorna um alerta. Esse alerta se aplica a qualquer componente de um projeto. Você recebe um alerta quando um componente monitorado atinge ou excede um valor definido por você. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Use o endpoint Retornar todos os alertas de um projeto para recuperar todos os alertas aos quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Sequência única de 24dígitos hexadecimais que identifica o alerta. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}Confirma o recebimento de um alerta existente . Esse alerta se aplica a 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 por você até que você reconheça o alerta. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "Proprietário da organização" ou "Proprietário do projeto". Use o endpoint Retornar todos os alertas de um projeto para recuperar todos os alertas aos quais o usuário autenticado tem acesso.
Este recurso permanece sob revisão e pode mudar. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Sequência única de 24dígitos hexadecimais que identifica o alerta. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Confirma ou não um alerta.
| acknowledgedUntil | string <date-time> Data e hora até as quais 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. |
| acknowledgementComment | string <= 200 caracteres Comentário que um usuário do MongoDB Cloud enviou ao reconhecer o alerta. |
| unacknowledgeAlert | booleano Sinalizador que indica para cancelar a confirmação de um alerta confirmado anteriormente. Por padrão, esse valor é definido como falso. Se definido como verdadeiro, ele substituirá o parâmetro acknowledgedUntil. |
{- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "unacknowledgeAlert": true
}{- "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",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}Retorna, adiciona, edita e remove índices do Atlas Search para o cluster especificado. Também retorna e atualiza analisadores definidos pelo usuário para o cluster especificado.
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 criá-lo. Somente clusters que executam o MongoDB v4.2 ou posterior podem usar o Atlas Search. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Cria um índice do Atlas Search na collection especificada.
| collectionName necessário | string Rótulo legível por humanos que identifica a coleção que contém um ou mais índices do Atlas Search. |
| database necessário | string Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search. |
| name necessário | string Rótulo legível por humanos que identifica este índice. Dentro de cada namespace, os nomes de todos os índices do namespace devem ser únicos. |
| numPartitions | inteiro <int32> Padrão: 1 Número de partições de índice. Os valores permitidos são [1, 2, 4]. |
| 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:
|
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. | |
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. |
Array de objetos (Definição de mapeamento sinônimo) Conjuntos de regras que mapeiam palavras em relação a seus sinônimos neste índice. |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "numPartitions": 1,
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search"
}
]Remove um índice de Atlas Search que você identificou com ID único. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}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 criá-lo. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Detalhes a serem atualizados no índice do Atlas Search.
| collectionName necessário | string Rótulo legível por humanos que identifica a coleção que contém um ou mais índices do Atlas Search. |
| database necessário | string Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search. |
| name necessário | string Rótulo legível por humanos que identifica este índice. Dentro de cada namespace, os nomes de todos os índices do namespace devem ser únicos. |
| numPartitions | inteiro <int32> Padrão: 1 Número de partições de índice. Os valores permitidos são [1, 2, 4]. |
| 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:
|
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. | |
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. |
Array de objetos (Definição de mapeamento sinônimo) Conjuntos de regras que mapeiam palavras em relação a seus sinônimos neste índice. |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "numPartitions": 1,
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}Exclui os nós de pesquisa para o cluster especificado.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Rótulo que identifica o cluster a ser excluído. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna os Nós de Pesquisa para o cluster especificado. Versões obsoletas: v2-{2024-05-30}, v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta que identifica o cluster para o qual retornar os nós de pesquisa. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}Atualiza os nós de pesquisa para o cluster especificado. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta que identifica o cluster para atualizar os nós de pesquisa. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. NOTA: Atualmente, aceitamos uma única configuração para todos os nós. |
{- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
]
}{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}Cria nós de pesquisa para o cluster especificado.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Rótulo que identifica o cluster para o qual criar nós de pesquisa. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. NOTA: Atualmente, aceitamos uma única configuração para todos os nós. |
{- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
]
}{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}Retorna todos os índices do Atlas Search no cluster especificado. Os índices do Atlas Search contêm os campos indexados e os analisadores utilizados para criar os índices. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "status": "DELETING"
}
], - "type": "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 criá-lo. Somente clusters que executam o MongoDB v4.2 ou posterior podem usar o Atlas Search. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Cria um índice do Atlas Search na collection especificada.
| collectionName necessário | string Rótulo que identifica a coleção para criar um índice do Atlas Search. |
| database necessário | string Rótulo que identifica o banco de dados que contém a coleção para criar um índice do Atlas Search. |
| name necessário | string Etiqueta 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. |
necessário | objeto (Definição do índice de pesquisa de texto) A definição do índice de pesquisa de texto definida pelo usuário. |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "type": "search",
- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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 que identifica o banco de dados que contém a coleção com um ou mais índices do Atlas Search. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "status": "DELETING"
}
], - "type": "search"
}
]Remove um índice do Atlas Search que você identificou com seu banco de dados, coleção e nome. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto. Essa exclusão é eventualmente consistente.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| 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 que identifica o banco de dados que contém a coleção com um ou mais índices do Atlas Search. |
| indexName necessário | string Nome do índice do Atlas Search a ser excluído. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna um índice do Atlas Search no projeto especificado. Você identifica este índice utilizando seu banco de dados, coleção e nome. O índice do Atlas Search contém os campos indexados e os analisadores utilizados para criar o índice. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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 que identifica o banco de dados que contém a coleção com um ou mais índices do Atlas Search. |
| indexName necessário | string Nome do índice do Atlas Search a ser retornado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}Atualiza um índice do Atlas Search que você identificou com seu banco de dados, nome da coleção e nome do índice. Os índices do Atlas Search definem os campos nos quais criar o índice e os analyzers a serem usados ao criá-lo. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Nome do cluster que contém a coleção cujo índice do Atlas Search você deseja atualizar. |
| 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 que identifica o banco de dados que contém a coleção com um ou mais índices do Atlas Search. |
| indexName necessário | string Nome do índice do Atlas Search a ser atualizado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Detalhes para atualizar o índice do Atlas Search.
necessário | Definição do índice de pesquisa de texto (objeto) ou Definição do índice de pesquisa vetorial (objeto) A definição do índice para a qual atualizar o índice de pesquisa. |
{- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}Remove um índice de Atlas Search que você identificou com ID único. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto. Essa exclusão é eventualmente consistente.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}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 criá-lo. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador de acesso a dados do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Nome do cluster que contém a coleção cujo índice do Atlas Search você deseja atualizar. |
| indexId necessário | string^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Detalhes a serem atualizados no índice do Atlas Search.
necessário | Definição do índice de pesquisa de texto (objeto) ou Definição do índice de pesquisa vetorial (objeto) A definição do índice para a qual atualizar o índice de pesquisa. |
{- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}Retorna e edita configurações de auditoria do banco de dados para projetos da nuvem do MongoDB.
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 auditar . Para usar esse recurso, a conta de serviço ou 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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "configurationType": "NONE",
- "enabled": false
}Atualiza a configuração de auditoria do projeto especificado . A configuração de auditoria define os eventos que o MongoDB Cloud registra no registro de auditar . Para usar esse recurso, a conta de serviço ou 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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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 |
| auditFilter | string Documento JSON que especifica quais eventos dever ser gravados. Use uma barra invertida ( |
| habilitado | booleano Padrão: false Sinalizador que indica se alguém habilitou a auditoria do banco de dados para o projeto especificado. |
{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "enabled": false
}{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "configurationType": "NONE",
- "enabled": false
}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.
Retorna a configuração de DNS personalizada para clusters AWS no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "enabled": true
}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 usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador do projeto do Atlas .
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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
}{- "enabled": true
}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.
Retorna todos os buckets de exportação associados ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
}
], - "totalCount": 0
}Cria um bucket de exportação de snapshot para um bucket do AWS S3, um container de armazenamento de blobs do Azure ou bucket de armazenamento do Google Cloud. Depois de criado, um snapshot pode ser exportado para o Export Bucket e seu referenciado AWS S3 Bucket, Azure Blob Storage Container ou Google Cloud Storage Bucket. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Especifica a função e o AWS S3 bucket, o Azure Blob Storage Container ou o Google Cloud Storage bucket ao qual o bucket de exportação deve fazer referência.
| cloudProvider necessário | string Etiqueta legível por humanos que identifica o provedor de nuvem para o qual os snapshots são exportados. |
| bucketName necessário | string [ 3 ... 63 ] caracteres Etiqueta legível por humanos que identifica o bucket3 da AWS para o qual a função está autorizada a exportar. |
| iamRoleId necessário | string^([a-f0-9]{24})$ String de caracteres 24-hexadecimais exclusiva que identifica o ID da função de acesso unificado da AWS que o MongoDB Cloud usa para acessar o bucket AWS S3. |
AWS
{- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592"
}AWS
{- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592",
}Exclui um bucket de exportação. A exportação automática deve ser desabilitada em todos os clusters desse projeto que são exportados para esse bucket de exportação antes de revogar o acesso. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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"
}Retorna um bucket de exportação associado ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
AWS
{- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592",
}Desabilita as configurações da Política de compliance de backup com o projeto especificado. Como pré-requisito, um tíquete de suporte precisa ser arquivado primeiro, instruções em https://www.mongodb.com/pt-br/docs/atlas/backup/cloud-backup/backup-compliance-policy/. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna as configurações da Política de compliance de backup com o projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "deletable": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
], - "state": "ACTIVE",
- "updatedDate": "2019-08-24T14:15:22Z",
- "updatedUser": "user@example.com"
}Atualiza as configurações da Política de Conformidade de Backup para o projeto especificado . Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| overwriteBackupPolicies | booleano Padrão: true Sinalização que indica se as políticas de backup não conformes devem ser substituídas pelas novas configurações de proteção de dados. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. |
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. |
| projectId | string^([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. |
{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "deletable": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
], - "state": "ACTIVE",
- "updatedDate": "2019-08-24T14:15:22Z",
- "updatedUser": "user@example.com"
}Retorna todas as tarefas de exportação de snapshot de backup em nuvem associados ao cluster Atlas especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador do projeto do Atlas .
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
{- "results": [
- {
- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}
], - "totalCount": 0
}Exporta um snapshot de backup para um Atlas cluster dedicado usando backups na nuvem para um bucket de exportação. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador do projeto do Atlas .
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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^([a-f0-9]{24})$ Cadeia de caracteres 24-hexadecimal exclusiva que identifica o bucket de exportação. |
| snapshotId necessário | string^([a-f0-9]{24})$ String exclusiva de 24caracteres hexadecimais que identifica o snapshot do backup em nuvem a ser exportado. |
{- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "snapshotId": "32b6e34b3d91647abb20e7b8"
}{- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}Retorna uma Tarefa de exportação de snapshot de backup em nuvem associado ao cluster Atlas especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador do projeto do Atlas .
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| exportId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 24exclusivo -string de caracteres hexadecimais que identifica a tarefa de exportação. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}Retorna todas as tarefas de restauração de backup em nuvem para um cluster de um projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}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 usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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 |
| 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 |
| 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 |
| snapshotId | string^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica o snapshot. |
| targetClusterName | string^[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 |
| targetGroupId | string^([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 |
{- "deliveryType": "automated",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8"
}{- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}Cancela uma tarefa de restauração de backup em nuvem de um cluster de um projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| restoreJobId necessário | string^([a-f0-9]{24})$ Sequência única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser removida. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna uma tarefa de restauração de backup na nuvem para um cluster de um projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser retornada. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}Remove todos os agendamentos de backup na nuvem do cluster especificado. Esse agendamento define quando o MongoDB Cloud realiza snapshots programados e por quanto tempo os armazena. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de administrador do projeto do Atlas . Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}Retorna o agendamento do 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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}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 usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Atualiza o agendamento de backup em nuvem para um cluster dentro do projeto especificado.
Observação: no corpo da solicitação, forneça apenas os campos que você deseja atualizar.
| autoExportEnabled | booleano Sinalizador que indica se o MongoDB Cloud exporta automaticamente os Snapshots de Backup em Nuvem para o Bucket de Exportação. |
Array de objetos (DiskBackupCopySetting20240805) Lista que contém um documento para cada item de configuração de cópia na política de backup desejada. | |
Array de objetos (DeleteCopiedBackups20240805) Lista que contém um documento para cada configuração de cópia excluída cujas cópias de backup você deseja excluir. | |
objeto (export) Política para exportar automaticamente snapshots de backup em nuvem. | |
Array de objetos (ExtraRetentionSetting) Lista que contém um documento para cada item de configuração de retenção extra na política de backup desejada. | |
Array de objetos (AdvancedDiskBackupSnapshotSchedulePolicy) <= 1 itens Regras definidas para este agendamento de backup. | |
| referenceHourOfDay | inteiro <int32> Hora do dia no Horário Universal Coordenado (UTC) que representa quando o MongoDB Cloud faz o snapshot. |
| referenceMinuteOfHour | inteiro <int32> Minuto do referenceHourOfDay que representa quando a nuvem do MongoDB tira o snapshot. |
| restoreWindowDays | inteiro <int32> Número de dias anteriores para os quais você pode restaurar com precisão do Continuous Cloud Backup. Você deve especificar um número inteiro positivo, diferente de zero. Esse parâmetro se aplica somente aos backups contínuos na nuvem. |
| updateSnapshots | booleano Sinalizador que indica se as alterações de retenção na política de backup atualizada devem ser aplicadas aos snapshots que o MongoDB Cloud fez anteriormente. |
| useOrgAndGroupNamesInExportPrefix | booleano Sinalizador que indica quando usar os nomes da organização e do projeto em vez dos UUIDs da organização e do projeto no caminho para os arquivos de metadados que o MongoDB Cloud faz upload para o seu Export Bucket. |
{- "autoExportEnabled": true,
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "deleteCopiedBackups": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "updateSnapshots": true,
- "useOrgAndGroupNamesInExportPrefix": true
}{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}Retorna todos snapshots de um cluster do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de somente leitura do projeto ou a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
], - "totalCount": 0
}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 usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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 |
| 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. |
{- "description": "string",
- "retentionInDays": 1
}{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}Remove um snapshot de um cluster fragmentado do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| snapshotId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}Retorna um snapshot de um cluster fragmentado do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de somente leitura do projeto ou a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| snapshotId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "configServerType": "EMBEDDED",
- "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "members": [
- {
- "cloudProvider": "AWS",
- "id": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotIds": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}Retorna todos snapshots de um cluster fragmentado do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de somente leitura do projeto ou a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "configServerType": "EMBEDDED",
- "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "members": [
- {
- "cloudProvider": "AWS",
- "id": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotIds": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
], - "totalCount": 0
}Remove o snapshot especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| snapshotId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna um snapshot do cluster especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de somente leitura do projeto ou a role de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| snapshotId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}Altera a data de validade de um snapshot de backup em nuvem para um cluster no projeto especificado, a conta de serviço ou a chave de API solicitante deve ter a função de gerenciador de backup do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| snapshotId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. |
{- "retentionUnit": "DAYS",
- "retentionValue": 5
}{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}Retorna todas as tarefas de restauração para uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
Esta API também pode ser utilizada em clusters Flex que foram criados com o ponto de extremidade createServerlessInstance ou em clusters Flex que foram migrados de instâncias sem servidor. Este ponto de extremidade será descontinuado em janeiro de 2026. Por favor, use o ponto de extremidade listFlexBackupRestoreJobs em vez disso.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Rótulo legível por humanos que identifica a instância sem servidor. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}Restaura um snapshot de uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
Esta API também pode ser utilizada em clusters Flex que foram criados com o ponto de extremidade createServerlessInstance ou em clusters Flex que foram migrados de instâncias sem servidor. Este ponto de extremidade será descontinuado em janeiro de 2026. Use o ponto de extremidade createFlexBackupRestoreJob.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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 |
| 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 |
| 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 |
| snapshotId | string^([a-f0-9]{24})$ String exclusiva de 24 caracteres hexadecimais que identifica o snapshot. |
| targetClusterName necessário | string^[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 |
| targetGroupId necessário | string^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado. |
{- "deliveryType": "automated",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8"
}{- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}Retorna uma tarefa de restauração para uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
Esta API também pode ser utilizada em clusters Flex que foram criados com o ponto de extremidade createServerlessInstance ou em clusters Flex que foram migrados de instâncias sem servidor. Este ponto de extremidade será desativado em janeiro de 2026. Use o ponto de extremidade getFlexBackupRestoreJob.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a tarefa de restauração a ser retornada. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}Retorna todos snapshots de uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Esta API também pode ser utilizada em clusters Flex que foram criados com o ponto de extremidade createServerlessInstance ou em clusters Flex que foram migrados de instâncias sem servidor. Este ponto de extremidade será descontinuado em janeiro de 2026. Use o ponto de extremidade listFlexBackups.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Rótulo legível por humanos que identifica a instância sem servidor. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
{- "results": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "mongodVersion": "string",
- "serverlessInstanceName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0
}
], - "totalCount": 0
}Retorna um snapshot de uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Este ponto de extremidade também pode ser usado em clusters Flex que foram criados com a API createServerlessInstance ou em clusters Flex que foram migrados de instâncias sem servidor. Este ponto de extremidade será descontinuado em janeiro de 2026. Use o ponto de extremidade getFlexBackup.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "mongodVersion": "string",
- "serverlessInstanceName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0
}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.
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 coleções de séries temporais ainda não é compatível com o MongoDB 6.0 ou superior. As migrações no MongoDB 6.0 ou superior ignorarão todas as coleções de séries temporais no cluster de origem. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Uma migração a ser criada.
necessário | objeto (Destino) Documento que descreve o destino da migração. |
| dropDestinationData | booleano Padrão: false 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. |
{- "destination": {
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnameSchemaType": "PUBLIC",
- "privateLinkId": "string"
}, - "dropDestinationData": false,
- "migrationHosts": [
- "vm001.example.com"
], - "sharding": {
- "createSupportingIndexes": true,
- "shardingEntries": [
- {
- "collection": "string",
- "database": "string",
- "shardCollection": {
- "key": [
- {
- "property1": { },
- "property2": { }
}
]
}
}
]
}, - "source": {
- "caCertificatePath": "string",
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "managedAuthentication": true,
- "password": "string",
- "ssl": true,
- "username": "string"
}
}{- "_id": "32b6e34b3d91647abb20e7b8",
- "lagTimeSeconds": 0,
- "migrationHosts": [
- "vm001.example.com"
], - "readyForCutover": true,
- "status": "NEW"
}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 função Proprietário da organização para chamar esse recurso com êxito. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Uma migração a ser validada.
necessário | objeto (Destino) Documento que descreve o destino da migração. |
| dropDestinationData | booleano Padrão: false 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. |
{- "destination": {
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnameSchemaType": "PUBLIC",
- "privateLinkId": "string"
}, - "dropDestinationData": false,
- "migrationHosts": [
- "vm001.example.com"
], - "sharding": {
- "createSupportingIndexes": true,
- "shardingEntries": [
- {
- "collection": "string",
- "database": "string",
- "shardCollection": {
- "key": [
- {
- "property1": { },
- "property2": { }
}
]
}
}
]
}, - "source": {
- "caCertificatePath": "string",
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "managedAuthentication": true,
- "password": "string",
- "ssl": true,
- "username": "string"
}
}{- "_id": "32b6e34b3d91647abb20e7b8",
- "errorMessage": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "sourceGroupId": "32b6e34b3d91647abb20e7b8",
- "status": "PENDING"
}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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 507f1f77bcf86cd799439011 String única de 24 dígitos hexadecimais que identifica a tarefa de validação. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "errorMessage": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "sourceGroupId": "32b6e34b3d91647abb20e7b8",
- "status": "PENDING"
}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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 6296fb4c7c7aa997cf94e9a8 String exclusiva de 24 dígitos hexadecimais que identifica a migração. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "lagTimeSeconds": 0,
- "migrationHosts": [
- "vm001.example.com"
], - "readyForCutover": true,
- "status": "NEW"
}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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Exemplo: 6296fb4c7c7aa997cf94e9a8 String exclusiva de 24 dígitos hexadecimais que identifica a migração. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorne todos os projetos que você pode migrar para a organização especificada.
| orgId necessário | string^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "deployments": [
- {
- "agentVersion": "string",
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "dbSizeBytes": 8192,
- "featureCompatibilityVersion": "string",
- "managed": true,
- "mongoDBVersion": "string",
- "name": "Project X sharded cluster",
- "oplogSizeMB": 3,
- "sharded": true,
- "shardsSize": 3,
- "tlsEnabled": true
}
], - "migrationHosts": [
- "string"
], - "name": "string",
- "projectId": "32b6e34b3d91647abb20e7b8"
}
]Remover um link 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.
| orgId necessário | string^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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"
}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.
| orgId necessário | string^([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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. |
{- "accessListIps": [
- "string"
]
}{- "linkToken": "string"
}Retorna todas as funções de acesso do provedor de nuvem com acesso ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "awsIamRoles": [
- {
- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
], - "azureServicePrincipals": [
- {
- "providerName": "AWS",
- "_id": "32b6e34b3d91647abb20e7b8",
- "atlasAzureAppId": "fa987465-057e-40db-aba0-9f2d4cc5853c",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "servicePrincipalId": "f25408bf-fda4-449e-87e7-67cf2d3e5615",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
]
}Cria uma role de acesso para o provedor de nuvem especificado. Alguns recursos do MongoDB Cloud usam essas roles de acesso do provedor de nuvem para a autenticação. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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. |
{- "providerName": "AWS"
}{- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}Retorna a função de acesso com o id especificado e com acesso ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ String única de 24 dígitos hexadecimais que identifica a role. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}Retorna, inicia ou termina uma simulação de interrupção de cluster.
Termina uma simulação de interrupção de cluster.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}Retorna uma simulação de interrupção para um cluster.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}Inicia uma simulação de interrupção de cluster.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Descreve a simulação de interrupção.
Array de objetos (AtlasClusterOutageSimulationOutageFilter) non-empty Lista de configurações que especificam o tipo de simulação de interrupção de cluster. |
{- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
]
}{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}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.
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 esse recurso, a conta de serviço ou a chave de API solicitante pode ter qualquer role no nível do cluster.
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "clusters": [
- {
- "alertCount": 0,
- "authEnabled": true,
- "availability": "available",
- "backupEnabled": true,
- "clusterId": "string",
- "dataSizeBytes": 0,
- "name": "string",
- "nodeCount": 0,
- "sslEnabled": true,
- "type": "REPLICA_SET",
- "versions": [
- "string"
]
}
], - "groupId": "string",
- "groupName": "string",
- "orgId": "string",
- "orgName": "string",
- "planType": "string",
- "tags": [
- "string"
]
}
], - "totalCount": 0
}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 com shards de tamanhos assimétricos. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Essa funcionalidade não está disponível para clusters sem servidor.
Este endpoint também pode ser utilizado em clusters Flex que foram criados usando o endpoint createCluster ou em antigos clusters M2/M5 que foram migrados para clusters Flex até janeiro de 2026. Por favor, use o ponto de extremidade listFlexClusters para clusters Flex. Versões obsoletas: v2-{2023-02-01}, v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: 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. |
{- "results": [
- {
- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
], - "totalCount": 0
}Cria um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Esse recurso pode criar clusters com shards de tamanhos assimétricos. Cada projeto aceita até 25 sistemas de banco de dados . Para usar esse recurso, a conta de serviço ou 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.
Observe que usar um instanceSize de M2 ou M5 criará um cluster Flex em vez disso. O suporte para o tamanho da instância M2 ou M5 será descontinuado em janeiro de 2026. Recomendamos utilizar a API createFlexCluster para essas configurações daqui em diante. Versões obsoletas: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Cluster a ser criado neste projeto.
| 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ção 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. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. |
objeto (ApiAtlasClusterAdvancedConfigurationView) Grupo de configurações que define um subconjunto dos detalhes avançados de configuração. | |
| backupEnabled | booleano Padrão: false Sinalizador que indica se o cluster pode executar backups. Se definido como |
objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. | |
| clusterType | string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster. |
| configServerManagementMode | string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. |
| diskWarmingMode | string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. |
| 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 |
| globalClusterSelfManagedSharding | booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. |
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. Em vez disso, é altamente recomendável usar tags de recursos. | |
objeto (EmployeeAccessGrantView) Funcionário do MongoDB recebeu nível de acesso e expiração para um cluster. | |
| mongoDBMajorVersion | string Versão principal do MongoDB do cluster. Defina para a versão binária principal. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. |
| name | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| pausado | booleano Sinalizador que indica se o cluster está pausado. |
| pitEnabled | booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. |
| redactClientLogData | booleano Habilitar ou desabilitar a supressão de logs. Essa configuração define o Use em Observação: alterar essa configuração em um cluster irá acionar uma reinicialização contínua assim que o cluster for atualizado. |
| replicaSetScalingStrategy | string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. |
Array de objetos (Especificações de replicação) Lista de configurações que configuram suas regiões de cluster. Essa array tem um objeto por fragmento que representa as configurações de nó em cada fragmento. Para conjuntos de réplicas, há apenas um objeto que representa as configurações dos nós. | |
| rootCertType | string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificação raiz que o cluster do MongoDB Cloud usa. O MongoDB Cloud é compatível com oInternet Security Research Group. |
Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. | |
| terminationProtectionEnabled | booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como |
| 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 |
cluster
{- "clusterType": "SHARDED",
- "name": "myCluster",
- "replicationSpecs": [
- {
- "regionConfigs": [
- {
- "analyticsAutoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M40",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 0
}, - "autoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M60",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "electableSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M60",
- "nodeCount": 3
}, - "priority": 7,
- "providerName": "AWS",
- "readOnlySpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M60",
- "nodeCount": 0
}, - "regionName": "US_EAST_1"
}
], - "zoneName": "Zone 1"
}, - {
- "regionConfigs": [
- {
- "analyticsAutoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M40",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M30",
- "nodeCount": 0
}, - "autoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M60",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "electableSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 3
}, - "priority": 7,
- "providerName": "AWS",
- "readOnlySpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 0
}, - "regionName": "US_EAST_1"
}
], - "zoneName": "Zone 1"
}
]
}{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}Retorna a lista de regiões disponíveis para o provedor de nuvem especificado na camada especificada. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: 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. |
{- "results": [
- {
- "instanceSizes": [
- {
- "availableRegions": [
- {
- "default": true,
- "name": "string"
}
], - "name": "string"
}
], - "provider": "AWS"
}
], - "totalCount": 0
}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 conta de serviço ou 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.
Este ponto de extremidade também pode ser usado em clusters Flex que foram criados usando o endpoint createCluster ou clusters antigos M2/M5 que foram migrados para clusters Flex até janeiro de 2026. Use o ponto de extremidade deleteFlexCluster para clusters Flex. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: 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. |
{- "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"
}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 com shards de tamanhos assimétricos. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Essa funcionalidade não está disponível para clusters sem servidor.
Este ponto de extremidade também pode ser utilizado em clusters Flex que foram criados usando o ponto de extremidade createCluster ou em antigos clusters M2/M5 que foram migrados para clusters Flex até janeiro de 2026. Utilize o ponto de extremidade getFlexCluster para clusters Flex. Versões obsoletas: v2-{2023-02-01}, v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}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 com shards de tamanhos assimétricos. Para atualizar a proteção de encerramento de um cluster, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto. Para todas as outras atualizações, a conta de serviço ou 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. Essa funcionalidade não está disponível para clusters sem servidor. Versões obsoletas: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
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ção 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. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. |
objeto (ApiAtlasClusterAdvancedConfigurationView) Grupo de configurações que define um subconjunto dos detalhes avançados de configuração. | |
| backupEnabled | booleano Padrão: false Sinalizador que indica se o cluster pode executar backups. Se definido como |
objeto (Conector MongoDB para configurações de Business Intelligence) Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster. | |
| clusterType | string Enum: "REPLICASET" "SHARDED" "GEOSHARDED" Configuração de nós que compõem o cluster. |
| configServerManagementMode | string Padrão: "ATLAS_MANAGED" Enum: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para otimizar o desempenho e a economia. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado. |
| diskWarmingMode | string Padrão: "FULLY_WARMED" Enum: "FULLY_WARMED" "VISIBLE_EARLIER" Seleção de modo de aquecimento do disco. |
| 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 |
| globalClusterSelfManagedSharding | booleano Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global. Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita. Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível. Essa configuração não pode ser alterada depois que o cluster for implantado. |
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. Em vez disso, é altamente recomendável usar tags de recursos. | |
objeto (EmployeeAccessGrantView) Funcionário do MongoDB recebeu nível de acesso e expiração para um cluster. | |
| mongoDBMajorVersion | string Versão principal do MongoDB do cluster. Defina para a versão binária principal. Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto. Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior. |
| name | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| pausado | booleano Sinalizador que indica se o cluster está pausado. |
| pitEnabled | booleano Sinalizador que indica se o cluster usa backups contínuos na nuvem. |
| redactClientLogData | booleano Habilitar ou desabilitar a supressão de logs. Essa configuração define o Use em Observação: alterar essa configuração em um cluster irá acionar uma reinicialização contínua assim que o cluster for atualizado. |
| replicaSetScalingStrategy | string Padrão: "WORKLOAD_TYPE" Enum: "SEQUENCIAL" "WORKLOAD_TYPE" "NODE_TYPE" Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster. Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais. Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência. Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas. |
Array de objetos (Especificações de replicação) Lista de configurações que configuram suas regiões de cluster. Essa array tem um objeto por fragmento que representa as configurações de nó em cada fragmento. Para conjuntos de réplicas, há apenas um objeto que representa as configurações dos nós. | |
| rootCertType | string Padrão: "ISRGROOTX1" Valor: "ISRGROOTX1" Autoridade de certificação raiz que o cluster do MongoDB Cloud usa. O MongoDB Cloud é compatível com oInternet Security Research Group. |
Array de objetos (Tag do recurso) Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. | |
| terminationProtectionEnabled | booleano Padrão: false Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como |
| 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 |
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "globalClusterSelfManagedSharding": true,
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS"
}, - "mongoDBMajorVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}Retorna a configuração interna do AutoScaling para clusters fragmentados. Esse ponto de extremidade pode ser usado para fins de diagnóstico para garantir que clusters fragmentados atualizados a partir de APIs mais antigas tenham suporte para fazer AutoScaling de cada fragmento de forma independente.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "autoScalingMode": "INDEPENDENT_SHARD_SCALING"
}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/ preocupação de gravação, 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, clusters flexíveis ou clusters sem servidor. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}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/ preocupação de gravação, limites de índice e oplog e outras configurações do banco de dados . Para utilizar esse recurso, a Conta de Serviço ou Chave de API solicitante deve ter a função de "Gerenciador de cluster do projeto". Este recurso não está disponível para clusters gratuitos do M0, clusters de nível compartilhado do M2 e M5, clusters flexíveis ou clusters sem servidor. Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Detalhes de configuração avançados para adicionar a um cluster no projeto especificado.
| changeStreamOptionsPreAndPostImagesExpireAfterSeconds | |
| 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. |
| customOpensslCipherConfigTls12 | Array de strings Itens Enum: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" A lista personalizada de conjuntos de cifras OpenSSL para TLS 1.2. Este campo só é válido quando |
| defaultMaxTimeMS | inteiro <int32> Limite de tempo padrão em milissegundos para a conclusão de operações de leitura individuais. |
| defaultWriteConcern | string Nível padrão de confirmação de solicitado pelo MongoDB para operações de gravação quando nenhuma é especificada pelo driver. |
| javascriptEnabled | booleano Sinalizador que indica se o cluster permite a execução de operações que realizam execuções em JavaScript no lado do servidor. Ao usar 8.0+, recomendamos desabilitar o JavaScript do lado do servidor e usar operadores de pipeline de agregação como alternativa de melhor desempenho. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| sampleSizeBIConnector | inteiro <int32> > = 0 Número de documentos por banco de dados a serem amostrados ao coletar informações de esquema. |
| tlsCipherConfigMode | string Enum: "CUSTOM" "PADRÃO" O modo de configuração do conjunto de cifras TLS. O modo padrão usa os conjuntos de cifras padrão. O modo personalizado permite que você especifique conjuntos de cifras personalizados para TLS 1.2 e TLS 1.3. |
| 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. |
{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}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 esse recurso, a Conta de Serviço ou Chave de API solicitante deve ter a função de "Gerenciador de cluster do projeto". Versões obsoletas: v2-{2023-01-01}
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}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 conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "changeStatus": "PENDING",
}Concede acesso ao cluster de funcionários do MongoDB por um determinado período e no nível especificado para um cluster.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Conceder nível de acesso e expiração.
| expirationTime necessário | string <date-time> Data de expiração da concessão de acesso do funcionário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. |
| grantType necessário | string Enum: "CLUSTER_DATABASE_LOGS" "CLUSTER_INFRASTRUCTURE" "CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA" Nível de acesso a ser concedido aos funcionários do MongoDB. |
{- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS"
}{- "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"
}Fixa a versão de compatibilidade do recurso (FCV) à versão atual do MongoDB e define a data de expiração da fixação. Se já existir uma fixação FCV para o cluster, a chamada desse método apenas atualizará a data de validade da fixação existente e não fixará novamente a FCV.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Parâmetros de solicitação opcionais para ajustar a configuração de pinagem do FCV.
| Data de expiração | string <date-time> Data de expiração do FCV fixo. Se não for especificada, a data de validade será padronizada para 4 semanas a partir da data em que o FCV foi originalmente fixado. Observe que esse campo não pode exceder 4 semanas a partir da data de fixação. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. |
{- "expirationDate": "2019-08-24T14:15:22Z"
}{- "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"
}Revoga um acesso ao cluster de funcionário do MongoDB concedido anteriormente.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Desafixa a versão de compatibilidade do recurso atual (FCV). Este recurso não está disponível para clusters em rapid release.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível para humanos que identifica este cluster. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Solicitações carregando o conjunto de dados de amostra MongoDB no agrupamento especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "completeDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "state": "WORKING"
}Confere o progresso do carregamento do conjunto de dados de amostra em um cluster. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^([a-f0-9]{24})$ Cadeia exclusiva de 24 dígitos hexadecimais que identifica o conjunto de dados de amostra carregado. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "completeDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "state": "WORKING"
}Retorna, adiciona e edita namespaces fixados para o cluster ou para o processo especificado. Também retorna dados para as métricas de latência a nível de coleção.
Retorna uma lista dos namespaces fixos de determinado cluster, um conjunto de namespaces selecionados manualmente pelos usuários para coletar métricas de latência de query.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster do qual recuperar os namespaces fixados. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}Adicione a lista fornecida de namespaces à lista de namespaces fixados existente para a coleção de métricas de latência em nível de coleção para o grupo e cluster fornecidos.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster para fixar namespaces. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
Lista de strings de namespace (combinação de nome de banco de dados e coleção) para fixar a coleção de métricas de latência de query.
| namespaces | Array de strings unique Lista de strings de namespace (combinação de banco de dados e collection) no host ou cluster especificado. |
{- "namespaces": [
- "string"
]
}{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster para fixar namespaces. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
Lista de strings de namespace (combinação de nome de banco de dados e coleção) para fixar a coleção de métricas de latência de query.
| namespaces | Array de strings unique Lista de strings de namespace (combinação de banco de dados e collection) no host ou cluster especificado. |
{- "namespaces": [
- "string"
]
}{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}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.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster do qual desafixar os namespaces. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
Lista de strings de namespace (combinação de nome de banco de dados e coleção) para fixar a coleção de métricas de latência de query.
| namespaces | Array de strings unique Lista de strings de namespace (combinação de banco de dados e collection) no host ou cluster especificado. |
{- "namespaces": [
- "string"
]
}{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}Retorna o subconjunto de namespaces do cluster fornecido, classificado pelo maior tempo total de execução (decrescente) dentro da janela de tempo fornecida.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Etiqueta legível por humanos que identifica o cluster para fixar namespaces. |
| clusterView necessário | string Enum: "primário" "secondary" "INDIVIDUAL_PROCESS" Etiqueta legível por humanos que identifica a topologia do cluster para a qual recuperar as métricas. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| iniciar | string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto. |
| end | string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período. |
| 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. |
{- "groupId": "32b6e34b3d91647abb20e7b8",
- "identifierId": "string",
- "rankedNamespaces": [
- "string"
]
}Obtenha uma lista das medidas em nível de cluster de latência da Coll Stats para o namespace especificado.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^[a-zA-Z0-9][a-zA-Z0-9-]*$ Rótulo legível por humanos que identifica o cluster para o qual recuperar métricas. |
| clusterView necessário | string Enum: "primário" "secondary" "INDIVIDUAL_PROCESS" Etiqueta 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| metrics | Array de strings unique 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, esse recurso retornará séries de dados para todas as métricas de Latência de Coll Stats. |
| iniciar | string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto. |
| end | string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período. |
| 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. |
{- "clusterId": "string",
- "clusterView": "string",
- "collectionName": "string",
- "databaseName": "string",
- "end": "2019-08-24T14:15:22Z",
- "granularity": "PT1M",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "measurements": [
- {
- "dataPoints": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "name": "string",
- "units": "BYTES"
}
], - "processId": "mongodb.example.com:27017",
- "start": "2019-08-24T14:15:22Z"
}Retorna todos os nomes de métricas de latência do Coll Stats disponíveis e suas respectivas unidades para o projeto especificado no momento da solicitação.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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"
}Retorna o subconjunto de namespaces de um determinado processo classificado pelo maior tempo total de execução (decrescente) dentro do intervalo de tempo especificado.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| iniciar | string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto. |
| end | string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período. |
| 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. |
{- "groupId": "32b6e34b3d91647abb20e7b8",
- "identifierId": "string",
- "rankedNamespaces": [
- "string"
]
}Obtenha uma lista das medições de nível de processo do Coll Stats Latency para o namespace fornecido.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| metrics | Array de strings unique 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, esse recurso retornará séries de dados para todas as métricas de Latência de Coll Stats. |
| iniciar | string <date-time> Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto. |
| end | string <date-time> Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período. |
| 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. |
{- "collectionName": "string",
- "databaseName": "string",
- "end": "2019-08-24T14:15:22Z",
- "granularity": "PT1M",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "measurements": [
- {
- "dataPoints": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "name": "string",
- "units": "BYTES"
}
], - "processId": "mongodb.example.com:27017",
- "start": "2019-08-24T14:15:22Z"
}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 para o projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
]Cria uma função personalizada no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "Proprietário do projeto", "Proprietário do processamento do fluxo de projetos" ou "Administrador de acesso ao banco de dados do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Cria uma função personalizada no projeto especificado.
Array de objetos (Ação de privilégio do banco de dados) Lista das ações de privilégio específicas que a função concede. | |
Array de objetos (Role herdada) unique Lista das funções incorporadas que esta função personalizada herda. | |
| roleName necessário | string Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto. |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}Remove uma função personalizada do projeto especificado. Não é possível remover uma função personalizada que deixaria uma ou mais roles secundárias sem roles ou ações principais. Também não é possível remover uma função personalizada que deixaria um ou mais usuários do banco de dados sem roles. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "Proprietário do projeto", "Proprietário do processamento do fluxo de projetos" ou "Administrador de acesso ao banco de dados do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| roleName necessário | string Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "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"
}Retorna uma função personalizada para o projeto especificado . Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| roleName necessário | string Rótulo legível por humanos que identifica a função para a solicitação. Este nome deve ser exclusivo para essa função personalizada neste projeto. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}Atualiza uma função personalizada no projeto especificado . Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role "Proprietário do projeto", "Proprietário do processamento do fluxo de projetos" ou "Administrador de acesso ao banco de dados do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| roleName necessário | string Etiqueta legível para humanos que identifica a role da solicitação. Este nome deve ser exclusivo para essa role personalizada neste projeto. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Atualiza uma função personalizada no projeto especificado.
Array de objetos (Ação de privilégio do banco de dados) Lista das ações de privilégio específicas que a função concede. | |
Array de objetos (Role herdada) unique Lista das funções incorporadas que esta função personalizada herda. |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
]
}{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}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.
Retorna os detalhes de todas as instâncias do banco de dados federado no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto ou superior.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: 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. |
[- {
- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- null
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
]Cria uma instância do banco de dados federado no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: 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. |
Detalhes para criar uma instância do banco de dados federado no projeto especificado.
objeto (Fornecedor de nuvem de federação de dados) Provedor de nuvem em que essa instância de banco de dados federado está hospedada. | |
objeto (DataLakeDataProcessRegion) Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente. | |
| name | string Etiqueta legível por humanos que identifica a instância do banco de dados federado. |
objeto (DataLakeStorage) Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud. |
{- "cloudProviderConfig": {
- "aws": {
- "roleId": "32b6e34b3d91647abb20e7b8",
- "testS3Bucket": "string"
}, - "azure": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "gcp": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "name": "string",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}Remove uma instância do banco de dados federado do projeto especificado . Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}Retorna os detalhes de uma instância do banco de dados federado dentro do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções "somente leitura" do projeto ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}Atualiza os detalhes de uma instância do banco de dados federado no projeto especificado . Para utilizar este recurso, a Conta de Serviço ou Chave de API solicitante deve possuir a função de Proprietário do Projeto ou superior.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: 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. |
Detalhes de um banco de dados federado a ser atualizado no projeto especificado.
objeto (Fornecedor de nuvem de federação de dados) Provedor de nuvem em que essa instância de banco de dados federado está hospedada. | |
objeto (DataLakeDataProcessRegion) Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente. | |
| name | string Etiqueta legível por humanos que identifica a instância do banco de dados federado. |
objeto (DataLakeStorage) Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud. |
{- "cloudProviderConfig": {
- "aws": {
- "roleId": "32b6e34b3d91647abb20e7b8",
- "testS3Bucket": "string"
}, - "azure": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "gcp": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "name": "string",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}Retorna limites de consulta para uma instância de bancos de dados federados no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}
]Exclui um limite de query para uma instância do banco de dados federado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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.
|
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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"
}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 conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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.
|
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}Cria ou atualiza um limite de consulta para uma instância do banco de dados federado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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.
|
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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. |
{- "overrunPolicy": "BLOCK",
- "value": 0
}{- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}Baixa os registros de consulta da instância do banco de dados federado especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções "Proprietário do projeto" ou "Acesso de gravação/leitura aos dados do projeto". A API não suporta chamadas diretas com o esquema de resposta json. Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.YYYY-MM-DD+gzip".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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. |
| 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. |
{- "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"
}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 conta de serviço ou a chave de API solicitante deve ter as funções "somente leitura" do projeto ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| incluir contagem | booleano Padrão: true Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. |
| itemsPerPage | inteiro [ 1 .. 500 ] Padrão: 100 Número de itens que a resposta retorna por página. |
| pageNum | inteiro >= 1 Padrão: 1 Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "results": [
- {
- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
], - "totalCount": 0
}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 conta de serviço ou a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
Endpoint privado para instâncias do banco de dados federados e Online Archives para adicionar ao projeto especificado.
| azureLinkId | string ID do link que identifica a conexão de endpoint privado do Azure. |
| comment | string String legível para humanos para associar a esse endpoint privado. |
| customerEndpointDNSName | string Etiqueta legível por humanos para identificar o nome DNS do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para a região. |
| customerEndpointIPAddress | string^(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... Endereço IP usado para se conectar ao endpoint privado do Azure. |
| endpointId necessário | string^vpce-[0-9a-f]{17}$ String única alfanumérica de 24 caracteres que identifica o endpoint privado. |
| Mensagem de erro | string Mensagem de erro descrevendo uma falha aprovando a solicitação de endpoint privado. |
| fornecedor | string Padrão: "AWS" Valor: "AWS" Etiqueta legível por humanos que identifica o provedor de serviços de nuvem. O Atlas Data Lake suporta apenas Amazon Web Services. |
| região | string Etiqueta legível por humanos para identificar a região do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para customerEndpointDNSName. |
| Status | string Enum: "PENDENTE" "OK" "FAILED" "DELETING" Status da solicitação de conexão do endpoint privado. |
| type | string Padrão: "DATA_LAKE" Valor: "DATA_LAKE" Etiqueta legível para humanos que identifica o tipo de recurso associado a este endpoint privado. |
{- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}{- "results": [
- {
- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
], - "totalCount": 0
}Remove um endpoint privado para instâncias do banco de dados federado e Online Archives no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de proprietário do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}Retorna o endpoint privado especificado para instâncias do banco de dados federado ou Online Archives no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções "somente leitura" do projeto ou "Administrador de Charts do projeto".
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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^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. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}Retorna, edita e remove Atlas Data Lake Pipelines e execuções associadas.
Retorna uma lista de Data Lake Pipelines. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
[- {
- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
]Cria um pipeline de data lake.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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. |
{- "datasetRetentionPolicy": {
- "units": "DAYS",
- "value": 1
}, - "name": "string",
- "sink": { },
- "source": {
- "type": "PERIODIC_CPS"
}, - "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}Remove um pipeline do Data Lake.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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"
}Retorna os detalhes de um Data Lake Pipeline dentro do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}Atualiza um Data Lake Pipeline.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto 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. |
{- "datasetRetentionPolicy": {
- "units": "DAYS",
- "value": 1
}, - "name": "string",
- "sink": { },
- "source": {
- "type": "PERIODIC_CPS"
}, - "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
| groupId necessário | string^([a-f0-9]{24})$ Exemplo: 32b6e34b3d91647abb20e7b8 Sequência única de 24 dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID 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}$ Etiqueta legível para humanos que identifica o Data Lake Pipeline. |
| envelope | booleano Padrão: false Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON |
| pretty | booleano Padrão: false Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. |
[- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0