VPC プライベートエンドポイントを一覧表示する

GET /groups/{groupId}/apps/{appId}/security/private_endpoints

tokenAuth

アプリ用に構成されているすべてのプライベートエンドポイントのリストを取得します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。

応答

200 application/ JSON

エンドポイントが正常に一覧表示されました。
応答属性の非表示応答属性の表示オブジェクト
- _id string
- cloud_provider_region string
  
  プライベートエンドポイントをホストするクラウドプロバイダーリージョン。
- cloud_provider_endpoint_id string
  
  クラウドプロバイダーからのプライベートエンドポイント ID。
- comment string
  
  エンドポイントを説明するオプションのコメント。
- endpoint_type string
  
  エンドポイントの型。非推奨の "legacy" エンドポイントの移行の詳細については、レガシーエンドポイントの移行を参照してください。
  
  値は sync、general、または legacy です。
404

見つかりません

GET /groups/{groupId}/apps/{appId}/security/private_endpoints

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

応答の例（200）

[
  {
    "_id": "string",
    "cloud_provider_region": "aws-us-east-1",
    "cloud_provider_endpoint_id": "vpce-12345678",
    "comment": "string",
    "endpoint_type": "sync"
  }
]