1 つのプロバイダーの 1 つのプライベートエンドポイントを返す
指定されたプライベートエンドポイントの接続状態を返します。プライベートエンドポイントサービスは、1つのクラウドがホストする1つのプロジェクトに属するこのプライベートエンドポイントを管理します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
このプライベートエンドポイントを管理するクラウド サービス プロバイダー。
値は
AWS、AZURE、またはGCPです。デフォルト値はAWSです。 -
返したいプライベートエンドポイントを識別するユニークな文字列。endpointIdパラメータの形式は、AWS と Azure で異なります。Azure プライベートエンドポイントでは、endpointIdを URL エンコードする必要があります。
形式は次のパターンと一致する必要があります:
^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\w._()]+)%2[fF]providers%2[fF]Microsoft\.Network%2[fF]privateEndpoints%2[fF]([-\w._()]+)。 -
返したいプライベートエンドポイントが属するプライベートエンドポイントサービスを識別する、ユニークな 24 桁の 16 進数文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"cloudProvider": "AWS",
"deleteRequested": true,
"errorMessage": "string",
"connectionStatus": "PENDING_ACCEPTANCE",
"interfaceEndpointId": "string"
}{
"cloudProvider": "AZURE",
"deleteRequested": true,
"errorMessage": "string",
"privateEndpointConnectionName": "string",
"privateEndpointIPAddress": "string",
"privateEndpointResourceId": "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln",
"status": "INITIATING"
}{
"cloudProvider": "GCP",
"deleteRequested": true,
"errorMessage": "string",
"endpointGroupName": "string",
"endpoints": [
{
"endpointName": "string",
"ipAddress": "string",
"status": "INITIATING"
}
],
"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": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}