API Servidor de Preparação Otimizada

Chamadas de API para publicar e verificar status de publicação de servidores de preparação de ambientes

Publicação Otimizada

A publicação otimizada oferece mais controle sobre o processo de publicação de imagens do servidor de preparação.

Publicar imagem de forma otimizada

POST /environments/{amb_uuid}/servers/template/optimized-publish/

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
amb_uuid	Sim	UUID do ambiente

Body da Requisição

Campo	Tipo	Descrição
stop_server	boolean	Se o servidor de preparação deve ser parado durante a criação da imagem
notify_list	array	Lista de emails a serem notificados ao fim da publicação
replace_instances	object	Configurações de publicação
replace_instances.block_instances	boolean	Se instâncias com versões anteriores devem ser bloqueadas após publicação
replace_instances.block_users	boolean	Se deve solicitar reconexão dos usuários (requer block_instances: true)
replace_instances.block_users_message	string	Mensagem de aviso de reconexão (quando block_users: true)
replace_instances.block_users_seconds	number	Tempo de desconexão em segundos (quando block_users: true)

Valores aceitos para block_users_seconds

Valor	Equivalente
300	5 minutos
600	10 minutos
900	15 minutos
1200	20 minutos
1500	25 minutos
1800	30 minutos

Modos de Publicação

Modo 1 - Padrão

Instâncias atualizadas são iniciadas, instâncias anteriores não são bloqueadas, usuários não são desconectados.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": false,
        "block_users": false
    }
}

Modo 2 - Manter usuários conectados

Instâncias atualizadas são iniciadas, instâncias anteriores são bloqueadas, mas usuários não são desconectados.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": true,
        "block_users": false
    }
}

Modo 3 - Solicitar reconexão de usuários

Instâncias anteriores são bloqueadas e usuários são notificados para reconexão.

Importante: Não é possível enviar block_users: true com block_instances: false.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": true,
        "block_users": true,
        "block_users_message": "Mensagem de aviso aos usuários",
        "block_users_seconds": 300
    }
}

Opção: Parar servidor durante criação

Qualquer modo acima aceita stop_server: true para deixar o servidor de preparação indisponível durante a criação da imagem.

{
    "stop_server": true,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": false,
        "block_users": false
    }
}

Resposta

Status: 202 Accepted

{
    "status": 202,
    "message": "Publicacao iniciada com sucesso.",
    "request_id": "149cbd70-5241-4e62-88a7-c87bcdf2eecc"
}

Verificar status de publicação otimizada

Verifica o status da publicação de imagem para a requisição especificada.

GET /environments/{amb_uuid}/servers/template/optimized-publish/{request_id}/

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
amb_uuid	Sim	UUID do ambiente
request_id	Sim	UUID da requisição da publicação

Resposta

Status: 200 OK

{
    "status": 200,
    "image_publication_status": "PUBLISHING",
    "message": "Publicação em andamento."
}

Valores possíveis de image_publication_status

Valor	Descrição
PUBLISHING	Publicação em andamento
PUBLISHED	Publicação concluída
ERROR	Erro na publicação