Atualizar um endpoint privado para uma instância sem servidor Obsoleto(a)

REMENDO /api/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}

Atualiza um private endpoint para uma instância sem servidor.

Essa funcionalidade não funciona para clusters Flex. Para continuar usando pontos de extremidade privados depois que o sem servidor for substituído pelo Flex, use um cluster dedicado. Esse ponto de extremidade será encerrado em 22 de janeiro de 2026.

Requisitos de função

Proprietário do projeto

parâmetros de caminho

groupId string Obrigatório

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
instanceName string Obrigatório

Etiqueta legível por humanos que identifica a instância sem servidor associada ao ponto de extremidade do locatário que será atualizado.

O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
endpointId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o ponto de extremidade do locatário que será atualizado.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

envelope booleano

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

O valor padrão é false.

aplicação/json

corpo, corpo

objeto Obrigatório

Objeto usado para atualização.

Atualizações para um endpoint de tenant da AWS sem servidor.

comment string

Comentário legível por humanos associado ao private endpoint.

O comprimento máximo é 80.
providerName string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o provedor de nuvem do ponto de extremidade do locatário

O valor é AWS.
cloudProviderEndpointId string

String exclusiva que identifica a interface de rede do ponto de extremidade privado.

O formato deve corresponder ao seguinte padrão: ^vpce-[0-9a-f]{17}$.

Atualizações para um ponto final do tenant do Azure sem servidor.

comment string

Comentário legível por humanos associado ao private endpoint.

O comprimento máximo é 80.
providerName string Obrigatório Discriminador

Etiqueta legível por humanos que identifica o provedor de nuvem do ponto de extremidade do locatário

O valor é AZURE.
cloudProviderEndpointId string

String exclusiva que identifica a interface de rede do endpoint privado Azure para esse serviço de endpoint privado.

O formato deve corresponder ao seguinte padrão: ^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\.Network/privateEndpoints/[-\w._()]+$.
privateEndpointIpAddress string

Endereço IPv4 do endpoint privado em sua VNet do Azure que alguém adicionou a esse serviço de endpoint privado.

O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

Respostas

200 aplicação/json

OK
Um dos seguintes:
objeto AWS objeto do Azure
Visualize um endpoint de locatário da AWS sem servidor.

Ocultar atributos Mostrar atributos

_id string

Cadeia de 24 caracteres hexadecimais exclusiva que identifica o endpoint privado.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

cloudProviderEndpointId string

String exclusiva que identifica a interface de rede do ponto de extremidade privado.

O formato deve corresponder ao seguinte padrão: ^vpce-[0-9a-f]{17}$.

comment string

Comentário legível por humanos associado ao private endpoint.

O comprimento máximo é 80.

endpointServiceName string

String exclusiva que identifica o serviço de endpoints do Amazon Web Services (AWS) PrivateLink. O MongoDB Cloud retorna nulo enquanto cria o serviço endpoint.

O formato deve corresponder ao seguinte padrão: ^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}.

Mensagem de erro string

Mensagem de erro legível por humanos que indica a condição de erro associada ao estabelecimento da conexão do endpoint privado.

Status string

Etiqueta legível por humanos que indica o status operacional atual do endpoint privado.

Os valores são RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED ou DELETING.

providerName string

Etiqueta legível por humanos que identifica o provedor de serviços de nuvem.

O valor é AWS.
Visualize um endpoint de locatário do Azure sem servidor.

Ocultar atributos Mostrar atributos

_id string

Cadeia de 24 caracteres hexadecimais exclusiva que identifica o endpoint privado.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

cloudProviderEndpointId string

String exclusiva que identifica a interface de rede do endpoint privado Azure que alguém adicionou a esse serviço de endpoint privado.

O formato deve corresponder ao seguinte padrão: ^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\.Network/privateEndpoints/[-\w._()]+$.

comment string

Comentário legível por humanos associado ao private endpoint.

O comprimento máximo é 80.

endpointServiceName string

String exclusiva que identifica o serviço de endpoints privados do Azure. O MongoDB Cloud retorna nulo enquanto cria o serviço endpoint.

O formato deve corresponder ao seguinte padrão: ^pls_[0-9a-f]{24}$.

Mensagem de erro string

Mensagem de erro legível por humanos que indica a condição de erro associada ao estabelecimento da conexão do endpoint privado.

Status string

Etiqueta legível por humanos que indica o status operacional atual do endpoint privado.

Os valores são RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED ou DELETING.

privateEndpointIpAddress string

Endereço IPv4 do endpoint privado em sua VNet do Azure que alguém adicionou a esse serviço de endpoint privado.

O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

privateLinkServiceResourceId string

Caminho relativo à raiz que identifica o Serviço de Link Privado do Azure que o MongoDB Cloud gerencia. O MongoDB Cloud retorna nulo enquanto cria o serviço endpoint.

providerName string

Etiqueta legível por humanos que identifica o provedor de serviços de nuvem.

O valor é AZURE.
400 aplicação/json

Solicitação inválida.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe corda | zero
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão corda | zero
  
  Mensagens de erro de aplicativo retornadas com este erro.
401 aplicação/json

Não autorizado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe corda | zero
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão corda | zero
  
  Mensagens de erro de aplicativo retornadas com este erro.
403 aplicação/json

Forbidden.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe corda | zero
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão corda | zero
  
  Mensagens de erro de aplicativo retornadas com este erro.
404 aplicação/json

Não encontrado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe corda | zero
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão corda | zero
  
  Mensagens de erro de aplicativo retornadas com este erro.
500 aplicação/json

Erro interno do servidor.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe corda | zero
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão corda | zero
  
  Mensagens de erro de aplicativo retornadas com este erro.

PATCH /API/atlas/v1.0/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}

curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "comment": "string",
  "providerName": "AWS",
  "cloudProviderEndpointId": "string"
}'

Exemplos de solicitação

{
  "comment": "string",
  "providerName": "AWS",
  "cloudProviderEndpointId": "string"
}

{
  "comment": "string",
  "providerName": "AZURE",
  "cloudProviderEndpointId": "string",
  "privateEndpointIpAddress": "string"
}

Exemplos de resposta (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "cloudProviderEndpointId": "string",
  "comment": "string",
  "endpointServiceName": "string",
  "errorMessage": "string",
  "status": "RESERVATION_REQUESTED",
  "providerName": "AWS"
}

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "cloudProviderEndpointId": "string",
  "comment": "string",
  "endpointServiceName": "string",
  "errorMessage": "string",
  "status": "RESERVATION_REQUESTED",
  "privateEndpointIpAddress": "string",
  "privateLinkServiceResourceId": "string",
  "providerName": "AZURE"
}

Exemplos de resposta (400)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}

Exemplos de resposta (401)

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

Exemplos de resposta (403)

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

Exemplos de resposta (404)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}

Exemplos de resposta (500)

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