パブリックプレビュー:フィードバックを提供してください : Amazon Web Services S3 バケット、 Azure Blob ストレージ コンテナ、またはGoogle Cloud Platformストレージ バケットのスナップショット エクスポート バケットを作成します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
作成が完了すると、スナップショットはエクスポート バケットと、その参照先のAmazon Web Services S3 バケット、 Azure Blob ストレージ コンテナ、またはGoogle Cloud Platformストレージ バケットにエクスポートできます。 このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクト オーナーのロールが必要です。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-createexportbucket と対応します。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api cloudBackups createExportBucket [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--file | string | false | APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | createExportBbucket のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--version | string | false | API 呼び出しで使用する API バージョン [options: "2023-01-01", "2024-05-30"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2024-05-30" になります。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
Amazon Web Services
以下のファイルを作成し、保存します payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592" }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api cloudBackups createExportBucket --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Amazon Web Services
以下のファイルを作成し、保存します payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592" }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
Azure
以下のファイルを作成し、保存します payload.json
{ "bucketName": "examplecontainer", "cloudProvider": "AZURE", "roleId": "668c5f0ed436263134491592", "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
GCP
以下のファイルを作成し、保存します payload.json
{ "bucketName": "export-bucket", "cloudProvider": "GCP", "roleId": "668c5f0ed436263134491592" }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8