1 つのスナップショット エクスポート バケットを作成
指定されたAmazon Web Services S3 バケットのエクスポート バケットを作成します。 作成が完了すると、スナップショットはエクスポート バケットとその参照先のAmazon Web Services S3 バケットにエクスポートできます。 このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに プロジェクト バックアップ マネージャー ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
エクスポートAmazon Web Services 3バケットが参照するAmazon Web Services S バケットと IAM ロールを指定します。
-
ロールがエクスポートを許可されている AWS S3 バケットを識別する、人間が判読できるラベル。
最小長は
3、最大長は63です。 -
スナップショットがエクスポートされるクラウドプロバイダーを識別する、人間が判読可能なラベル。
値は
AWS、AZURE、またはGCPです。 -
MongoDB Cloud が AWS S3 バケットにアクセスするために使用する Unified AWS Access ロール 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"
}