Atualizar uma instância sem servidor em um projeto

REMENDO /api/atlas/v2/groups/{groupId}/serverless/{name}

Atualiza uma instância sem servidor no projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.

Essa API também pode ser usada em clusters Flex que foram criados com o endpoint createServerlessInstance ou clusters Flex que foram migrados de instâncias sem servidor. Esse endpoint será encerrado em de 2026 janeiro. Backups contínuos não são suportados e serverlessContínuoBackupEnabled não entrará em vigor nesses clusters. Em vez disso, use o endpoint updateFlexCluster .

updateFlexCluster

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})$.

  • name string Obrigatório

    Rótulo legível por humanos que identifica a instância sem servidor.

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

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.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
application/vnd.atlas.2023-01-01+json

corpo, corpo Obrigatório

Atualize uma instância sem servidor em um projeto.

  • serverlessBackupOptions objeto

    Grupo de configurações que configuram o backup sem servidor.

    Ocultar atributo serverlessBackupOptions Mostrar atributo serverlessBackupOptions objeto
    • serverlessContínuoBackupEnabled booleano

      Sinalizador que indica se a instância sem servidor usa Backup contínuo sem servidor. Se este parâmetro false for, a instância sem servidor utilizará Backup Básico.

      | Opção | Descrição | |---|---| | Backup contínuo sem servidor | O Atlas tira snapshots incrementais dos dados em sua instância sem servidor a cada seis horas e permite restaurar os dados de um ponto selecionado nas últimas 72 horas. O Atlas também tira snapshots diários e retém esses snapshots diários por 35 dias. Para saber mais, consulte Custos de instância sem servidor. | | Backup Básico | O Atlas tira snapshots incrementais dos dados em sua instância sem servidor a cada seis horas e retém apenas os dois snapshots mais recentes. Você pode usar essa opção gratuitamente. |

      O valor padrão é true.

  • tags array[objeto]

    Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância sem servidor.

    Par de valores-chave que marca e categoriza uma organização, projeto ou cluster do MongoDB Cloud. Por exemplo, environment : production.

    Hide tags attributes Mostrar atributos das tags objeto
    • chave string Obrigatório

      Constante que define o conjunto da tag. Por exemplo, environment na marcação environment : production .

      O comprimento mínimo é 1, o comprimento máximo é 255.

    • valor string Obrigatório

      Variável que pertence ao conjunto da tag. Por exemplo, production na marcação environment : production .

      O comprimento mínimo é 1, o comprimento máximo é 255.

  • terminationProtectionEnabled booleano

    Sinalizador que indica se a proteção de rescisão está habilitada na instância sem servidor. Se definido para true, o MongoDB Cloud não excluirá a instância sem servidor. Se definido para false, o MongoDB Cloud excluirá a instância sem servidor.

    O valor padrão é false.

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Connection strings objeto

      Coleção de localizadores uniformes de recursos que apontam para o banco de dados MongoDB.

      Formato de URI da connection string
      Ocultar atributos connectionStrings Mostrar atributos connectionStrings objeto
      • privateEndpoint array[objeto]

        Lista de connection strings com reconhecimento de endpoints privados que você pode usar para se conectar a essa instância sem servidor por meio de um endpoint privado. Esse parâmetro retornará somente se você tiver criado um endpoint privado para essa instância sem servidor e ele estiver DISPONível.

        string de conexão de endpoint privado que você pode usar para se conectar a essa instância sem servidor por meio de um endpoint privado.

        Ocultar atributos privateEndpoint Mostrar atributos privateEndpoint objeto
        • pontos de extremidade array[objeto]

          Lista que contém os endpoints privados por meio da qual você se conecta ao MongoDB Cloud ao usar connectionStrings.privateEndpoint[n].srvConnectionString.

          Detalhes de um endpoint privado implantado para esta instância sem servidor.

          Ocultar atributos de endpoints Mostrar atributos de endpoints objeto
          • endpointId string

            String única que o provedor de nuvem usa para identificar o endpoint privado.

          • providerName string

            Fornecedor de nuvem onde o endpoint privado está implementado.

            Os valores são AWS ou AZURE.

          • região string

            Região onde o endpoint privado está implantado.

        • srvConnectionString string

          string de conexão privada com reconhecimento de endpoint que usa o protocolo mongodb+srv:// para se conectar ao MongoDB Cloud por meio de um endpoint privado. O protocolo mongodb+srv informa ao driver para procurar a lista de sementes de hosts no Sistema de Nome de Domínio (DNS).

        • type string

          Tipo de processo do MongoDB ao qual seu aplicação se conecta.

          O valor é MONGOS.

      • standardSrv string

        string de conexão pública que você pode usar para se conectar a esta instância sem servidor. Esta string de conexão utiliza o protocolo mongodb+srv://.

        Formato de URI da connection string
    • data de criação string(data-hora)

      Data e hora em que o MongoDB Cloud criou esta instância sem servidor. O MongoDB Cloud representa esse registro de data/hora no formato ISO 8601 em UTC.

    • groupId string

      String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

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

    • id string

      String exclusiva de 24dígitos hexadecimais que identifica a instância sem servidor.

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

    • Versão do MongoDB string

      Versão do MongoDB que a instância sem servidor executa.

      O formato deve corresponder ao seguinte padrão: ([\d]+\.[\d]+\.[\d]+).

    • name string

      Rótulo legível por humanos que identifica a instância sem servidor.

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

    • providerSettings objeto Obrigatório

      Grupo de configurações do fornecedor de nuvem que definem a instância sem servidor do MongoDB provisionada.

      Ocultar atributos providerSettings Mostrar atributos providerSettings objeto
      • backingProviderName string Obrigatório

        Provedor de serviços de nuvem no qual a MongoDB Cloud provisionou a instância sem servidor.

        Os valores são AWS, AZURE ou GCP.

      • eficazDiskSizeGBLimit integer(int32)

        Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Este valor não é configurável para clusters sem servidor ou efetivamente flexíveis.

      • efetiveInstanceSizeName string

        Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

        Um dos seguintes:

        Os valores são M10, M20, M30, M40, M50, M60, M80, M100, M140, M200, M300, R40, R50, R60, R80, R200, R300, R400, R700, M40_NVME, M50_NVME, M60_NVME, M80_NVME, M200_NVME ou M400_NVME.

        Os valores são M10, M20, M30, M40, M50, M60, M80, M90, M200, R40, R50, R60, R80, R200, R300, R400, M60_NVME, M80_NVME, M200_NVME, M300_NVME, M400_NVME ou M600_NVME.

        Os valores são M10, M20, M30, M40, M50, M60, M80, M140, M200, M250, M300, M400, R40, R50, R60, R80, R200, R300, R400 ou R600.

      • eficazProviderName string

        Provedor de serviços de nuvem no qual a MongoDB Cloud provisionou efetivamente a instância sem servidor.

      • providerName string

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

        O valor é SERVERLESS. O valor padrão é SERVERLESS.

      • regionName string Obrigatório

        Rótulo legível por humanos que identifica a localização geográfica de sua instância sem servidor do MongoDB . A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Para obter uma lista completa de nomes de regiões, consulte AWS, GCP e Azure.

    • serverlessBackupOptions objeto

      Grupo de configurações que configuram o backup sem servidor.

      Ocultar atributo serverlessBackupOptions Mostrar atributo serverlessBackupOptions objeto
      • serverlessContínuoBackupEnabled booleano

        Sinalizador que indica se a instância sem servidor usa Backup contínuo sem servidor. Se este parâmetro false for, a instância sem servidor utilizará Backup Básico.

        | Opção | Descrição | |---|---| | Backup contínuo sem servidor | O Atlas tira snapshots incrementais dos dados em sua instância sem servidor a cada seis horas e permite restaurar os dados de um ponto selecionado nas últimas 72 horas. O Atlas também tira snapshots diários e retém esses snapshots diários por 35 dias. Para saber mais, consulte Custos de instância sem servidor. | | Backup Básico | O Atlas tira snapshots incrementais dos dados em sua instância sem servidor a cada seis horas e retém apenas os dois snapshots mais recentes. Você pode usar essa opção gratuitamente. |

        O valor padrão é true.

    • stateName string

      Etiqueta legível para humanos que indica qualquer atividade atual que esteja sendo realizada neste cluster pelo plano de controle Atlas . Com exceção dos estados CREATING e DELETING, os clusters devem estar sempre disponíveis e ter um nó primário, mesmo quando em estados que indicam atividade contínua.

      • IDLE: o Atlas não está fazendo alterações neste cluster e pode-se presumir que todas as alterações solicitadas por meio da UI ou da API foram aplicadas.
      • CREATING: um cluster que está sendo provisionado pela primeira vez retorna o estado CREATING até que esteja pronto para conexões. Certifique-se de que a Lista de Acesso IP e os Usuários do Banco de Dados estejam configurados antes de tentar se conectar.
      • UPDATING: Uma alteração solicitada por meio da UI, API, AutoScaling ou outra atividade programada está ocorrendo.
      • DELETING: o cluster está em processo de exclusão e será excluído em breve.
      • REPAIRING: Um ou mais nós no cluster estão sendo devolvidos ao serviço pelo plano de controle Atlas . Outros nós devem continuar fornecendo serviços normalmente.

      Os valores são IDLE, CREATING, UPDATING, DELETING ou REPAIRING.

    • tags array[objeto]

      Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância sem servidor.

      Par de valores-chave que marca e categoriza uma organização, projeto ou cluster do MongoDB Cloud. Por exemplo, environment : production.

      Hide tags attributes Mostrar atributos das tags objeto
      • chave string Obrigatório

        Constante que define o conjunto da tag. Por exemplo, environment na marcação environment : production .

        O comprimento mínimo é 1, o comprimento máximo é 255.

      • valor string Obrigatório

        Variável que pertence ao conjunto da tag. Por exemplo, production na marcação environment : production .

        O comprimento mínimo é 1, o comprimento máximo é 255.

    • terminationProtectionEnabled booleano

      Sinalizador que indica se a proteção de rescisão está habilitada na instância sem servidor. Se definido para true, o MongoDB Cloud não excluirá a instância sem servidor. Se definido para false, o MongoDB Cloud excluirá a instância sem servidor.

      O valor padrão é false.

  • 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 string

      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 string

      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 string

      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 string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 402 aplicação/json

    Pagamento necessário.

    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 string

      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 string

      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 string

      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 string

      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 string

      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 string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 409 aplicação/json

    Conflito.

    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 string

      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 string

      Mensagens de erro de aplicativo retornadas com este erro.

PATCH /api/atlas/v2/groups/{groupId}/serverless/{name}
atlas api serverlessInstances updateGroupServerlessInstance --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdateGroupServerlessInstanceApiParams{}
	sdkResp, httpResp, err := client.ServerlessInstancesApi.
		UpdateGroupServerlessInstanceWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \
  -d '{ <Payload> }'
Exemplos de solicitação
{
  "serverlessBackupOptions": {
    "serverlessContinuousBackupEnabled": true
  },
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false
}
Exemplos de resposta (200)
{
  "connectionStrings": {
    "privateEndpoint": [
      {
        "endpoints": [
          {
            "endpointId": "string",
            "providerName": "AWS",
            "region": "string"
          }
        ],
        "srvConnectionString": "string",
        "type": "MONGOS"
      }
    ],
    "standardSrv": "string"
  },
  "createDate": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mongoDBVersion": "string",
  "name": "string",
  "providerSettings": {
    "backingProviderName": "AWS",
    "effectiveDiskSizeGBLimit": 42,
    "": "M10",
    "effectiveProviderName": "string",
    "providerName": "SERVERLESS",
    "regionName": "string"
  },
  "serverlessBackupOptions": {
    "serverlessContinuousBackupEnabled": true
  },
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false
}
Exemplos de resposta (400)
{
  "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"
}
Exemplos de resposta (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (402)
{
  "error": 402,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Payment Required",
  "errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}
Exemplos de resposta (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
  "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"
}
Exemplos de resposta (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}