Developer Network

Documentação

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

Agendamento de snapshot

Manipulando agendamento de snapshots em servidores cloud via API.

Listagem de agendamentos

Lista os agendamentos de snapshot de um determinado servidor cloud.

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

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
{
  "data": [
    {
      "type": "scheduled_snapshots",
      "id": 62,
      "attributes": {
        "cycle": "daily",
        "name": "dfgsdf",
        "history_size": 1
      }
    },
    {
      "type": "scheduled_snapshots",
      "id": 84,
      "attributes": {
        "cycle": "daily",
        "name": "Snapshot diário",
        "history_size": 2
      }
    }
  ],
  "links": {
    "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots?page%5Bnumber%5D=2&page%5Bsize%5D=1",
    "first": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "prev": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "next": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots?page%5Bnumber%5D=3&page%5Bsize%5D=2",
    "last": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots?page%5Bnumber%5D=3&page%5Bsize%5D=2"
  },
  "meta": {
    "total": 5
  }
}

Detalhe do agendamento

Exibe as informações sobre um agendamento de snapshot.

Parâmetro Descrição Retornado por padrão
cycle
  • daily (Diário)
  • weekly (Semanal)
  • monthly (Mensal)
Sim
name Nome dado ao agendamento, fornecido ao criar um novo agendamento Sim
created_at Data de criação do agendamento Sim
history_size Limite de snapshots armazenados para o agendamento Sim
GET:
https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots/80

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "data": {
    "type": "scheduled_snapshots",
    "id": 80,
    "attributes": {
      "cycle": "daily",
      "name": "api_test",
      "created_at": "2015-05-13T08:41:32-03:00",
      "history_size": 1
    }
  },
  "links": {
    "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots/80"
  }
}

Criar

Criar um agendamento de snapshot automático.

POST:
https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots

Parâmetros:

Parâmetro Descrição Exemplo Obrigatório
name Nome que descreve o agendamento do snapshot. snap3 Sim
cycle Periodicidade da criação do snapshot. daily/weekly/monthly Sim
history_size Limite de armazenamento, novos snapshots substituem os mais antigos. Maior que 0 Sim
1
2
3
4
5
6
7
8
9
10
{
  "data": {
    "type": "scheduled_snapshots",
    "attributes": {
      "name": "snap3",
      "cycle": "daily",
      "history_size": "1"
    }
  }
}

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "data": {
    "type": "scheduled_snapshots",
    "id": 86,
    "attributes": {
      "cycle": "daily",
      "name": "snap3",
      "history_size": 1
    }
  },
  "links": {
    "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots/86"
  }
}

Excluir agendamento

Exclui um agendamento de snapshot do servidor.

DELETE:
https://DOMINIO/v1/cloud/servers/SERVER_NAME/scheduled_snapshots/2436

Código HTTP: 202