Atlas クラスター OnlineAr Archives の一時停止

項目一覧

構文

Arguments
オプション
継承されたオプション
出力
例

クラスター用に指定されたオンラインアーカイブを一時停止します。

このコマンドを使用するには、プロジェクトデータアクセス管理者ロールのユーザーアカウントまたは API キーで認証する必要があります。

構文

コマンド構文

atlas clusters onlineArchives pause <archiveId> [options]

Arguments

名前	タイプ	必須	説明
archiveId	string	true	一時停止するオンラインアーカイブの一意の識別子です。

オプション

名前	タイプ	必須	説明
--clusterName	string	true	クラスターの名前。
-h, --help		false	一時停止用のヘルプ
-o, --output	string	false	出力形式。有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。完全な出力を表示するには、 -o JSONオプションを使用します。
--projectId	string	false	使用するプロジェクトを識別する 16 進数の string。このオプションは、構成ファイルまたは環境変数の設定を上書きします。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

出力

コマンドが成功すると、CLI は次のサンプルのような出力を返します。括弧内の値は値を表します。

Online archive '<Id>' paused.

例

# Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json

戻る

list

始める