VPC プライベートエンドポイントを変更する

PUT /groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}

tokenAuth

プライベートエンドポイントの設定を更新します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

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

VPC プライベートエンドポイントの _id ObjectID。

application/ JSON

body 必須

cloud_provider_region string 必須

プライベートエンドポイントをホストするクラウドプロバイダーリージョン。
cloud_provider_endpoint_id string 必須

クラウドプロバイダーからのプライベートエンドポイント ID。
comment string

エンドポイントを説明するオプションのコメント。
endpoint_type string 必須

エンドポイントの型。エンドポイントの型と廃止されたエンドポイントの "general" または "sync" への移行の詳細については、「VPC プライベートエンドポイントの使用」を参照してください。

値は sync または general です。

応答

200 application/ JSON

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

見つかりません

PUT /groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}

curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"cloud_provider_region":"aws-us-east-1","cloud_provider_endpoint_id":"vpce-12345678","comment":"string","endpoint_type":"sync"}'

リクエスト例

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

応答の例（200）

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