AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

atlas api cloudBackups updateCompliancePolicy

指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を更新します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Owner ロールが必要です。

このコマンドは自動生成されており、1:1 は Atlas API のエンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupbackupcompliancepolicy. に対応しています。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api cloudBackups updateCompliancePolicy [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

updateCompliancePolicy のヘルプ

-o, --output

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- outputFile

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--overwriteBackupPolicies

false

非準拠のバックアップ ポリシーを新しいデータ保護設定で上書きするかどうかを示すフラグ。

--pretty

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

--version

string

false

API 呼び出しで使用する API バージョン [options: "2023-01-01", "2023-10-01"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2023-10-01" になります。

-w, --watch

false

コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。

--watchTimeout

整数

false

監視がタイムアウトするまでの時間(秒単位)。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。