バックアップ操作用に、Atlas とクラウドプロバイダーのオブジェクトストレージサービス間の安全なプライベート接続のために、指定されたリージョンにプライベートエンドポイントを作成します。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
作成するプライベートエンドポイントのクラウドプロバイダーを識別する、人間が判読可能なラベル。
値は
AWSです。
クエリ パラメータ
-
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。
body
必須
指定されたリージョンに、オブジェクトストレージのバックアップ操作用にプライベートエンドポイントを作成します。
-
クラウドプロバイダーを識別する、人間が判読可能なラベル。
値は
AWSです。 -
MongoDB Cloud がAWSでホストされているMongoDBクラスター ノードを配置する物理的なロケーション。選択したリージョンは、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Cloud は専有クラスターを配置するときに、そのプロバイダーとリージョンにVPCまたはVPC接続が存在するかどうかを確認します。変換できない場合、 MongoDB Cloud は配置の一部としてそれらを作成します。MongoDB Cloud はVPCに CIDR ブロックを割り当てます。新しいVPCピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。
値は
US_GOV_WEST_1、US_GOV_EAST_1、US_EAST_1、US_EAST_2、US_WEST_1、US_WEST_2、CA_CENTRAL_1、EU_NORTH_1、EU_WEST_1、EU_WEST_2、EU_WEST_3、EU_CENTRAL_1、AP_EAST_1、AP_NORTHEAST_1、AP_NORTHEAST_2、AP_NORTHEAST_3、AP_SOUTHEAST_1、AP_SOUTHEAST_2、AP_SOUTHEAST_3、AP_SOUTH_1、SA_EAST_1、CN_NORTH_1、CN_NORTHWEST_1、ME_SOUTH_1、AF_SOUTH_1、EU_SOUTH_1、またはGLOBALのいずれか）。
atlas api cloudBackups createBackupPrivateEndpoint --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.CreateGroupBackupPrivateEndpointApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
CreateGroupBackupPrivateEndpointWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints" \
-d '{ <Payload> }'{
"cloudProvider": "AWS",
"regionName": "US_GOV_WEST_1"
}{
"cloudProvider": "AWS",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"privateEndpointConnectionName": "string",
"regionName": "US_GOV_WEST_1",
"status": "INITIATING"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}