1 つのプロジェクトの 1 つのフェデレーティッドデータベースインスタンスとオンライン アーカイブ プライベートエンドポイントを作成
フェデレーティッドデータベースインスタンスとオンラインアーカイブ用のプライベートエンドポイントを 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 です。
eu-west-1 は com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e です。
eu-west-2 は com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9 です。
eu-central-1 は com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d です。
sa-east-1 は com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044 です。
ap-southeast-2 は com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e です。
ap-south-1 は com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d です。
このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーまたはプロジェクト チャート管理者ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。
-
Azureプライベートエンドポイント接続を識別するリンクID 。
-
このプライベートエンドポイントに関連付ける、人間が判読可能な文字列。
-
顧客の VPC エンドポイント DNS 名を識別するための人間が判読可能なラベル。定義されている場合は、リージョンの値も指定する必要があります。
-
Azureプライベートエンドポイントへの接続に使用されるIPアドレス。
形式は次のパターンと一致する必要があります:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$。 -
プライベート エンドポイントを識別するユニークな 22 文字の英数字文字列。
形式は次のパターンと一致する必要があります:
^vpce-[0-9a-f]{17}$。Atlas Data Lake は、 AWS PrivateLink 機能を使用してAmazon Web Services のプライベートエンドポイントをサポートします -
プライベートエンドポイントリクエストの承認の失敗を説明するエラーメッセージ。
-
クラウド サービス プロバイダーを識別する、人間が判読可能なラベル。Atlas Data Lake は Amazon Web Services のみをサポートしています。
値は
AWSです。デフォルト値はAWSです。 -
顧客の VPC エンドポイントのリージョンを識別するための、人間が判読可能なラベル。定義されている場合は、customerEndpointDNSName の値も指定する必要があります。
-
プライベートエンドポイント接続リクエストのステータス。
値は、
PENDING、OK、FAILED、またはDELETINGです。 -
このプライベートエンドポイントに関連付けられているリソースの種類を識別する、人間が判読可能なラベル。
値は
DATA_LAKEです。デフォルト値はDATA_LAKEです。
atlas api dataFederation createGroupPrivateNetworkSettingEndpointId --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupPrivateNetworkSettingEndpointIdApiParams{}
sdkResp, httpResp, err := client.DataFederationApi.
CreateGroupPrivateNetworkSettingEndpointIdWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}