1 つのプロバイダーの 1 つのプライベートエンドポイントサービスを作成

POST /api/atlas/v1.0/groups/{groupId}/privateEndpoint/endpointService

指定されたクラウドサービスプロバイダーのプライベートエンドポイントサービスを 1 つ作成します。このクラウドサービスプロバイダーは、プロジェクトのプライベートエンドポイントサービスを管理します。プライベートエンドポイントサービスを作成すると、MongoDB Cloud は、プライベートエンドポイントサービスを作成するクラウドプロバイダーのプロジェクトにネットワークコンテナを作成します（未作成の場合）。MongoDB Cloud のプライベートエンドポイントの用語の詳細については、「プライベートエンドポイントの概念」を参照してください。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーにプロジェクトオーナーロールが必要です。

プライベートエンドポイントの概念

path パラメータ

グループ ID string 必須

プロジェクトを識別する一意の 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

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

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリパラメータ

envelope ブール値

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

デフォルト値はfalseです。
pretty ブール値

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

デフォルト値はfalseです。

Prettyprint

application/ JSON

body 必須

指定されたクラウドサービスプロバイダーにプライベートエンドポイントを 1 件作成します。

providerName string 必須

プライベートエンドポイントサービス作成先のクラウドサービスプロバイダーを識別する、人間が判読可能なラベル。

値は AWS、AZURE、または GCP です。
リージョン string 必須

プライベートエンドポイントサービスを作成するクラウド・プロバイダーのリージョン。値として受け入れられるリージョンは、 Amazon Web Services、Google Cloud Platform、Microsoft Azure でそれぞれ異なります。

応答

200 application/ JSON

OK
次の 1 つ：
AWSオブジェクト AZUREオブジェクト GCPオブジェクト
プライベートエンドポイントサービス設定のグループ。

属性を非表示属性を表示

cloudProvider string 必須弁別子

要求されたエンドポイントサービスを提供するクラウドサービスプロバイダー。

値は AWS です。

errorsMessage string

プライベート接続リソースを要求するときに返されたエラーメッセージ。リクエストが成功した場合、リソースはnull を返します。

id string

プライベートエンドポイントサービスを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

regionName string

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

状態 string

MongoDB Cloud がこのリクエストを受信したときのプライベートエンドポイントサービス接続の状態。

値は、INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED、または DELETING です。

endpointServiceName string

Amazon Web Services （AWS） PrivateLink エンドポイントサービスを識別する一意の文字列。 MongoDB Cloud は、エンドポイントサービスの作成中に null を返します。

形式は次のパターンと一致する必要があります: ^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}。

interfaceEndpoints array[string]

指定されたプロジェクトに適用されたプライベートエンドポイントインターフェイスを識別する文字列のリスト。

各の形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
プライベートエンドポイントサービス設定のグループ。

属性を非表示属性を表示

cloudProvider string 必須弁別子

要求されたエンドポイントサービスを提供するクラウドサービスプロバイダー。

値は AZURE です。

errorsMessage string

プライベート接続リソースを要求するときに返されたエラーメッセージ。リクエストが成功した場合、リソースはnull を返します。

id string

プライベートエンドポイントサービスを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

regionName string

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

状態 string

MongoDB Cloud がこのリクエストを受信したときのプライベートエンドポイントサービス接続の状態。

値は、INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED、または DELETING です。

プライベートエンドポイント array[string]

このAzure Private Link Service に割り当てられたプライベートエンドポイントのリスト。

各の形式は次のパターンと一致する必要があります: ^\/subscriptions\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/resource[gG]roups\/([-\w._()]+)\/providers\/Microsoft\.Network\/privateEndpoints\/([-\w._()]+)。

privateLinkServiceName string

MongoDB Cloud が管理するAzure Private Link Service を識別する一意の文字列。

形式は次のパターンと一致する必要があります: ^pls_[0-9a-f]{24}$。

privateLinkServiceResourceId string

MongoDB Cloud が管理するAzure Private Link Service を識別するルート相対パス。この値を使用して、 Azure VNet へのプライベートエンドポイント接続を作成します。
プライベートエンドポイントサービス設定のグループ。

属性を非表示属性を表示

cloudProvider string 必須弁別子

要求されたエンドポイントサービスを提供するクラウドサービスプロバイダー。

値は GCP です。

errorsMessage string

プライベート接続リソースを要求するときに返されたエラーメッセージ。リクエストが成功した場合、リソースはnull を返します。

id string

プライベートエンドポイントサービスを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

regionName string

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

状態 string

MongoDB Cloud がこのリクエストを受信したときのプライベートエンドポイントサービス接続の状態。

値は、INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED、または DELETING です。

endpointGroupNames array[string]

Private Service Connect エンドポイントサービスに対応する Google Cloud ネットワークエンドポイントグループのリスト。

serviceAatchmentNames array[string]

MongoDB Cloud が Google Cloud Virtual Private Connection（VPC）ネットワーク全体で 1 つの Google Cloud Service にアクセスするために使用できるエンドポイントを識別する URL のリスト。

各の形式は次のパターンと一致する必要があります: https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+。
400 application/ JSON

無効なリクエストです。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
401 application/ JSON

許可されていません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
404 application/ JSON

見つかりません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
500 application/ JSON

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。

POST /API/Atlas/v1.0/groups/{groupId}/privateEndpoint/endpointService

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/endpointService' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"providerName":"AWS","region":"string"}'

リクエスト例

{
  "providerName": "AWS",
  "region": "string"
}

応答の例（200）

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointServiceName": "string",
  "interfaceEndpoints": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

{
  "cloudProvider": "AZURE",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "privateEndpoints": [
    "string"
  ],
  "privateLinkServiceName": "string",
  "privateLinkServiceResourceId": "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de"
}

{
  "cloudProvider": "GCP",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointGroupNames": [
    "string"
  ],
  "serviceAttachmentNames": [
    "string"
  ]
}

応答の例（400）

{
  "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"
}

応答の例（401）

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

応答の例（403）

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

応答の例（404）

{
  "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"
}

応答の例（500）

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}