Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

Atlas API dataFederation createDataFederationPrivateEndpoint

実験的な : フェデレーティッドデータベースインスタンスとオンラインアーカイブ用のプライベートエンドポイントを 1 つ指定のプロジェクトに追加します。

エンドポイントIDがすでに存在し、関連するコメントが変更されていない場合、Atlas Data Federation はエンドポイントIDリストに変更を加えません。エンドポイントIDがすでに存在し、関連するコメントが変更された場合、Atlas Data Federation はエンドポイントIDリスト内のコメントの値のみをアップデートします。エンドポイントID が存在しない場合、Atlas Data Federation は新しいエンドポイントをエンドポイントIDリスト内のエンドポイントのリストに追加します。各リージョンには、各リージョンのさまざまなエンドポイントに対応するサービス名が関連付けられています。us-east-1 は com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4 です。us-west-1 は com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb 。au-west-1 は com.amazonaws.vpce.au-west-1.vpce-svc-0824460b72e1a420e は です。au-west-2 は com.amazonaws.vpce.au-west-2.vpce-svc-052f1840aa0c4f1f9 は です。au-centeral-1 は com.amazonaws.vpce.au-center-1.vpce-svc-0ac8ce91871138c0d は です。sa-east-1 は com.amazonaws.vpce.SA-east-1.vpce-svc-0b56e75e8cdf50044 は com.amazonaws.vpce.SA-east-.vpce-svc-beecdf です。ap-thustheast-2 は com.amazonaws.vpce.ap-lasごと-2.vpce-svc-036f1de74d761706eap-outth-1 は com.amazonaws.vpce.ap-sort-1.vpce-svc-03eb8a541f96d356d は com.amazonaws.vpce.ap-sごとの.vpce-svc-ebafdd です。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。このコマンドは、OpsID: 'createDataFederationPrivateEndpoint' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Data-Federation/ 操作/createDataFederationPrivateEndpoint

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

-- envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ

--file

string

false

APIリクエストの内容を含むファイルへのパス

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数の文字列

-h, --help

false

createDataFederationPrivateEndpoint のヘルプ

--出力

string

false

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

-- output-file

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. を参照してください。

項目一覧