Personalize uma página de erro

Substitua as respostas de erro de um workload por páginas suas, uma por código de status, cada uma com tempo de cache e código de status de resposta próprios.

Última atualização

Ver como Markdown Configurar agente

Você pode substituir as respostas de erro de um workload por páginas suas, para vários códigos de status de uma vez, pelo Azion Console, pela Azion CLI ou pela API. Para criar o seu primeiro conjunto com uma página e vê-la substituir um 404, consulte Primeiros passos com Custom Pages.

Com Custom Pages, as páginas ficam em um conjunto de custom pages. Cada página responde a um código de status que o connector da aplicação retorna, e o conjunto serve páginas apenas depois que o deployment do workload o nomeia.

Uma aplicação que roda na API v3 define as suas páginas de erro em Error Responses. Para mais informações, consulte Error Responses.

Selecione uma interface. Os pré-requisitos e as etapas de cada tarefa seguem a sua escolha.

Pré-requisitos

  • Um workload e uma aplicação para ele servir. Para criar os dois, consulte Primeiros passos com Workloads.
  • Um connector que serve os documentos das suas páginas de erro, cada um no próprio caminho. Para mais informações, consulte Connectors.
  • Acesso ao Azion Console. Para mais informações, consulte Como acessar o Azion Console.
  • Um workload cujo deployment nomeia a aplicação.
  • Azion CLI, autorizada com a sua conta. Esta página corresponde à Azion CLI 4.23.0.
  • Um workload ainda sem deployment. A CLI define o conjunto de custom pages de um workload apenas quando cria o deployment, e um workload contém um deployment. Este guia cria o deployment.
  • O ID do workload, o ID da aplicação que o workload serve e o ID do connector.
  • Um personal token para o header Authorization, no formato Token [TOKEN VALUE]. Para criar um token, consulte Tokens pessoais.
  • curl ou outro cliente HTTP.
  • Um workload cujo deployment nomeia a aplicação.
  • O ID do workload, o ID da aplicação que o workload serve e o ID do connector.
  • O ID do deployment. azion list workload-deployment --workload-id <workload-id> o imprime na coluna ID.

Crie um conjunto com uma página para cada código

Cada página do conjunto recebe o próprio código de status, caminho no connector, tempo de cache e código de status de resposta. Uma página também pode responder com um código diferente daquele que o connector retornou, como um 404 no lugar de um 403. A Azion serve a página no próprio lugar, sem redirecionamento. Depois que você altera o documento de uma página, a Azion continua servindo a cópia em cache até que o tempo de cache dela termine. Para os códigos que uma página aceita e o intervalo de cada campo, consulte Configurações de custom page.

Para criar o conjunto com Azion CLI, salve um arquivo JSON com uma entrada em pages por código de status, aqui como pages.json. Este conjunto responde a um 404 com a página em /errors/404.html e responde a um 403 com a mesma página e o status 404:

JSON
01{"name": "my-error-pages", "active": true, "pages": [
02 {"code": "404", "page": {"type": "page_connector", "attributes": {"connector": <connector-id>, "ttl": 3600, "uri": "/errors/404.html", "custom_status_code": 404}}},
03 {"code": "403", "page": {"type": "page_connector", "attributes": {"connector": <connector-id>, "ttl": 3600, "uri": "/errors/404.html", "custom_status_code": 404}}}
04]}

Crie o conjunto a partir do arquivo:

azion create custom-pages --file pages.json

O comando imprime o ID do conjunto novo. O deployment precisa dele na próxima tarefa:

Created Custom Page with ID <custom-page-id>

Um arquivo cuja lista pages está vazia é recusado com Ensure this field has at least 1 elements.

Para criar o conjunto com a API, envie uma requisição POST para o endpoint de custom pages, com uma entrada em pages por código de status. Este conjunto responde a um 404 com a página em /errors/404.html e responde a um 403 com a mesma página e o status 404:

Shell
01curl --request POST \
02 --url https://api.azion.com/v4/workspace/custom_pages \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]' \
05 --header 'Content-Type: application/json' \
06 --data {
07 "name": "my-error-pages",
08 "active": true,
09 "pages": [
10 {"code": "404", "page": {"type": "page_connector", "attributes": {"connector": <connector-id>, "ttl": 3600, "uri": "/errors/404.html", "custom_status_code": 404}}},
11 {"code": "403", "page": {"type": "page_connector", "attributes": {"connector": <connector-id>, "ttl": 3600, "uri": "/errors/404.html", "custom_status_code": 404}}}
12 ]
13}

A API responde com 201 e o conjunto novo, incluindo o id dele. Uma requisição GET para /v4/workspace/custom_pages lista os seus conjuntos com os IDs deles. Um corpo cuja lista pages está vazia é recusado com Ensure this field has at least 1 elements.

Para criar o conjunto no Azion Console:

Abra a página Custom Pages

Acesse Azion Console > Custom Pages.

Inicie o conjunto

Selecione Create Custom Page. Para adicionar páginas a um conjunto que você já tem, selecione esse conjunto.

Nomeie o conjunto

Em Name, digite um nome que identifique o conjunto, como my-error-pages.

Selecione Create Custom Page Code
Selecione o código de status

Em Page Code, selecione o código de status que o seu connector retorna, como 404.

Selecione o connector

Em Connector, selecione o connector que guarda a página.

Digite o caminho da página

Em Page Path (URI), digite o caminho da página no connector, como /errors/404.html.

Defina o tempo de cache

Em Response TTL, digite o número de segundos que a página fica em cache, como 3600.

(Opcional) Defina o código de status de resposta

Em Response Custom Status Code, digite o código de status que o cliente recebe no lugar do original.

Adicione os outros códigos

Selecione Create Custom Page Code de novo para cada outro código de status e preencha os campos dele da mesma forma.

Salve o conjunto

Selecione Create. Em um conjunto que você já tem, selecione Save.

A tabela Page Codes lista uma linha por página, com Page Status Code, Page Path (URI), Custom Status Code e Response TTL.

Atribua o conjunto no deployment do workload

O deployment de um workload nomeia a aplicação, o firewall e o conjunto de custom pages dele. Apenas o conjunto de custom pages muda aqui, então a aplicação e o firewall mantêm os valores que o workload usa hoje.

Para atribuir o conjunto com Azion CLI, crie o deployment do workload com o conjunto em --custom-page:

Shell
01azion create workload-deployment \
02 --workload-id <workload-id> \
03 --name my-deployment \
04 --application-id <application-id> \
05 --custom-page <custom-page-id> \
06 --strategy-type default \
07 --active true \
08 --current true

O comando imprime o ID do deployment novo:

Created Workload Deployment with ID <deployment-id>

Se o workload usa um firewall, adicione --firewall-id <firewall-id> ao comando. Em um workload que já tem um deployment, o comando falha com The maximum number of deployments allowed per workload is 1. Azion CLI 4.23.0 não tem comando que altere um deployment, então atribua o conjunto a esse workload no Azion Console ou com a API.

Para atribuir o conjunto com a API, envie uma requisição PATCH para o deployment do workload. O conjunto vai em strategy.attributes.custom_page, ao lado da aplicação que o deployment nomeia hoje. Deixe firewall de fora se o deployment não tem firewall:

Shell
01curl --request PATCH \
02 --url https://api.azion.com/v4/workspace/workloads/<workload-id>/deployments/<deployment-id> \
03 --header 'Accept: application/json' \
04 --header 'Authorization: Token [TOKEN VALUE]' \
05 --header 'Content-Type: application/json' \
06 --data {
07 "strategy": {
08 "type": "default",
09 "attributes": {
10 "application": <application-id>,
11 "firewall": <firewall-id>,
12 "custom_page": <custom-page-id>
13 }
14 }
15}

A API responde com 202. O deployment então nomeia o seu conjunto em custom_page.

Para atribuir o conjunto no Azion Console:

Abra a página Workloads

Acesse Azion Console > Workloads.

Abra o workload

Selecione o workload cujas respostas de erro o conjunto substitui. O formulário de edição dele abre.

Selecione o seu conjunto

Na seção Deployment Settings, selecione o seu conjunto no campo Custom Page. Em um workload sem conjunto, o campo mostra Select a custom page.

Application e Firewall mantêm os valores que o workload serve hoje.

Salve o workload

Selecione Save.

Azion Console mostra “Your workload has been updated”, e o deployment do workload nomeia o seu conjunto.

Confirme que uma página substitui o erro

A verificação é a mesma para todas as interfaces. Uma mudança no deployment de um workload leva vários minutos para alcançar toda a infraestrutura distribuída da Azion, e as requisições podem receber a configuração anterior ou a atualizada nesse meio-tempo. Repita uma requisição até que as respostas concordem.

Solicite um caminho para o qual o seu connector retorna um código de status que o conjunto cobre. Substitua <your-domain> por um domínio que o workload serve, como o workload domain dele, no formato <id>.map.azionedge.net:

curl -s -D - https://<your-domain>/<missing-path>

Para uma página cujo código de status de resposta é 404, a resposta começa com esta linha de status, seguida dos headers que o seu connector envia e do documento no caminho da página:

HTTP/2 404

A resposta não traz header Location, então o cliente permanece na URL solicitada e não é redirecionado. Se a resposta de erro do próprio connector ainda chega depois que a mudança no deployment se propagou, consulte Solucionar problemas de Workloads.

Próximos passos

Configurações de custom pageConsulte cada código de status que uma página aceita, o intervalo de cada campo e os erros da API.Como Workloads funcionaAcompanhe uma resposta desde o código de status do connector até a página que o cliente recebe.Configurações de workloadVerifique cada campo do deployment que nomeia a aplicação, o firewall e o conjunto de custom pages.Solucionar problemas de WorkloadsDescubra por que um workload ainda retorna a resposta de erro do connector no lugar da sua página.