Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas API privateEndpointServices deletePrivateEndpoint

パブリックプレビュー:フィードバックを提供してください : 指定されたクラウドサービスプロバイダーによって管理されている、指定されたプロジェクトとプライベートエンドポイントサービスから 1 つのプライベートエンドポイントを削除します。

パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

最後のプライベートエンドポイントが特定のプライベートエンドポイントサービスから削除されると、そのプライベートエンドポイントサービス自体も削除されます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Owner ロールが必要です。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Private-エンドポイントサービス/操作/deletePrivateEndpoint

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

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

--cloudProvider

string

true

このプライベートエンドポイントを管理するクラウド サービス プロバイダー。

--endpointId

string

true

削除したいプライベートエンドポイントを識別するユニークな文字列。endpointIdパラメータの形式は、AWS と Azure で異なります。Azure プライベートエンドポイントでは、endpointIdを URL エンコードする必要があります。

--endpointServiceId

string

true

削除したいプライベートエンドポイントが属するプライベートエンドポイントサービスを識別する、ユニークな 24 桁の 16 進数文字列。

-- envelope

envelope

false

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

--groupId

string

true

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

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

-h, --help

false

deletePrivateEndpoint のヘルプ

-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 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8

戻る

createPrivateEndpointService

項目一覧