Criar um endpoint privado VPC

POSTAR /groups/{groupId}/apps/{appId}/security/private_endpoints
tokenAuth

Configure um novo endpoint privado para o aplicativo.

parâmetros de caminho

aplicação/json

corpo, corpo Obrigatório

  • cloud_provider_region string Obrigatório

    A região do provedor de nuvem que hospeda o endpoint privado.

  • cloud_provider_endpoint_id string Obrigatório

    A ID do endpoint privado do fornecedor de nuvem.

  • comment string

    Um comentário opcional que descreve o endpoint.

  • endpoint_type string Obrigatório

    O tipo de ponto de extremidade. Para obter mais informações sobre os tipos de ponto de extremidade e a migração de pontos de extremidade obsoletos para "general" ou "sync", consulte Usar um ponto de extremidade privado de VPC.

    Os valores são sync ou general.

Respostas

  • 201 aplicação/json

    Criado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • _id string
    • cloud_provider_region string

      A região do provedor de nuvem que hospeda o endpoint privado.

    • cloud_provider_endpoint_id string

      A ID do endpoint privado do fornecedor de nuvem.

    • comment string

      Um comentário opcional que descreve o endpoint.

    • endpoint_type string

      O tipo de endpoint. Para obter mais informações sobre a migração de "legacy" endpoints obsoletos, consulte Migrar endpoints legados.

      Os valores são sync, general ou legacy.
  • 400
    • Solicitação inválida
    • O ID do endpoint VPC (cloud_provider_endpoint_id) é inválido
    • O tipo de endpoint é "legado"
POST /groups/{groupId}/apps/{appId}/security/private_endpoints 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/security/private_endpoints' \
 --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"}'
Exemplos de solicitação 
{
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "comment": "string",
  "endpoint_type": "sync"
}
Exemplos de resposta (201) 
{
  "_id": "string",
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "comment": "string",
  "endpoint_type": "sync"
}