1개의 스냅샷 내보내기 버킷 만들기
지정된 Amazon Web Services S3 버킷에 대한 내보내기 버킷을 생성합니다. 생성된 스냅샷은 내보내기 버킷과 참조된 Amazon Web Services S3 버킷으로 내보낼 수 있습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$
패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelope
JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false
입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false
입니다.Prettyprint
body
필수 사항
내보내기 버킷이 참조해야 하는 Amazon Web Services Amazon Web Services S 버킷 및 IAM 역할 을 지정합니다.3
-
역할에 내보내기 권한이 부여된 AWS S3 버킷을 식별하는 인간 가독형 레이블입니다.
최소 길이는
3
, 최대 길이는63
입니다. -
스냅샷 을 내보내는 cloud 제공자 를 식별하는 사람이 읽을 수 있는 레이블입니다.
값은
AWS
,AZURE
또는GCP
입니다. -
MongoDB Cloud가 AWS S3 버킷에 액세스하는 데 사용하는 통합 AWS 액세스 역할 ID를 식별하는 고유한 24자리 16진수 문자열입니다.
형식은
^([a-f0-9]{24})$
패턴 과 일치해야 합니다.통합 AWS 액세스 역할 ID -
공개 IP가 아닌 PrivateLink를 통해 내보내기를 수행할지 여부를 나타냅니다. 기본값은 False입니다.
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"
}