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

atlas api globalClusters deleteCustomZoneMapping

指定されたグローバルクラスターのすべてのカスタム ゾーン マッピングを削除します。

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

カスタム ゾーン マッピングは、1 つの ISO 3166-2 ロケーション コードをグローバルクラスター内のゾーンに一致させます。カスタム ゾーン マッピングを削除すると、デフォルトのマッピングが復元されます。デフォルトでは、MongoDB Cloud は各ロケーション コードを最も近い地理的ゾーンにマッピングします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Owner ロールが必要です。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-v2/ 操作/operation-deletegroupclusterグローバル書込みカスタムゾーンマッピング。

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

コマンド構文
atlas api globalClusters deleteCustomZoneMapping [options]
名前
タイプ
必須
説明

--clusterName

string

true

このクラスターを識別する、人間が判読できるラベル。

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

deleteCustomZoneMapping のヘルプ

-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", "2023-02-01", "2024-08-05"] は、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイリングします。この値のデフォルトは "2024-08-05" です。

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api globalClusters deleteCustomZoneMapping --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8