Criar um bucket de exportação de snapshot
Cria um bucket de exportação para um determinado bucket do Amazon Web Services S3. Depois de criados, os snapshots podem ser exportados para o Bucket de Exportação e seu bucket S3 do Amazon Web Services referenciado. 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.
parâmetros de caminho
-
Sequência única 24de dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Especifica o Amazon Web Services 3 bucket do Amazon Web Services S e o role IAM ao qual o bucket de exportação deve fazer referência.
-
Etiqueta legível por humanos que identifica o bucket AWS S3 para o qual a função está autorizada a exportar.
O comprimento mínimo é
3, o comprimento máximo é63. -
Etiqueta legível por humanos que identifica o provedor de nuvem para o qual os snapshots são exportados.
Os valores são
AWS,AZUREouGCP. -
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.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.ID da função de acesso AWS unificado -
Indica se as exportações devem ser feitas por PrivateLink em vez de IPs públicos. O padrão é falso.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/backup/exportBuckets' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"bucketName":"export-bucket","cloudProvider":"AWS","iamRoleId":"32b6e34b3d91647abb20e7b8","requirePrivateNetworking":true}'{
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8",
"requirePrivateNetworking": true
}{
"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"region": "us-east-1",
"requirePrivateNetworking": true
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}