Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Templates Customizados

Manipulando templates customizados em servidores cloud via API

Listagem de templates customizados

Lista todos os templates customizados de um servidor cloud.

GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "data": [
      {
          "type": "custom_templates",
          "id": 6319,
          "attributes": {
              "name": "template3",
              "description": "mytemplate",
              "uuid": null,
              "taken_at": null,
              "status": "creating"
          }
      }
  ],
  "links": {
      "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates?page%5Bnumber%5D=1&page%5Bsize%5D=1"
  },
  "meta": {
      "total": 1
  }
}

Detalhes do template customizado

Exibe as informações de um template customizado.

Parâmetro Descrição Retornado por padrão
name Nome dado ao template, fornecido ao criar um novo template Sim
description Descrição dada ao template, fornecida ao criar um novo template Sim
uuid Identificador único, gerado após todo o processo de criação do template no servidor cloud Sim
taken_at Data gerada após todo o processo de criação do template no servidor cloud Sim
status
  • creating (Processando template)
  • done (template gerado com sucesso)
  • removing (Removendo template)
  • reverting (Restaurando o template)
  • waiting_deletion (Aguardando remoção)
  • error (Erro no template)
 Sim
GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates/6319

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

{
    "data": {
        "type": "custom_templates",
        "id": 6319,
        "attributes": {
            "name": "template3",
            "description": "mytemplate",
            "uuid": null,
            "taken_at": null,
            "status": "creating"
        },
        "relationships": {
            "scheduled_snapshot": {
                "links": {
                    "related": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots"
                }
            },
            "server": {
                "links": {
                    "related": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/"
                },
                "data": {
                    "type": "servers",
                    "id": "SERVER_NAME"
                }
            }
        }
    },
    "links": {
        "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates/6319"
    },
    "meta": {
        "actions": [
            "revert"
        ]
    }
}

Criar template customizado

Criar um novo template do servidor.

POST:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates

Parâmetros:

Parâmetro Descrição Exemplo Obrigatório
name Nome do template template4 Sim
description Descrição do template mytemplate4 Não 
1
2
3
4
5
6
7
8
9

{
  "data": {
    "type": "custom_templates",
    "attributes": {
      "name": "template4",
      "description": "mytemplate4"
    }
  }
}

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

{
  "data": {
      "type": "custom_templates",
      "id": 6320,
      "attributes": {
          "name": "template4",
          "description": "mytemplate4",
          "uuid": null,
          "taken_at": null,
          "status": "creating"
      },
      "relationships": {
          "scheduled_snapshot": {
              "links": {
                  "related": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots"
              }
          },
          "server": {
              "links": {
                  "related": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/"
              },
              "data": {
                  "type": "servers",
                  "id": "SERVER_NAME"
              }
          }
      }
  },
  "links": {
      "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates/6320"
  },
  "meta": {
      "actions": [
          "revert"
      ]
  }
}

Excluir template

Exclusão de um determinado template.

DELETE:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/custom_templates/6320

Código Resposta HTTP: 204