Developer Network

Documentação

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

Snapshots

Manipulando snapshots em servidores cloud via API.

Listagem de snapshot

Lista todos os snapshots de servidor cloud.

GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/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
33
34
35
36
{
  "data": [
    {
      "type": "snapshots",
      "id": 2697,
      "attributes": {
        "name": "xen_tools_example",
        "description": null,
        "uuid": "2ad95b48-eb90-73bf-a764-e4e50e3b154d",
        "taken_at": "2015-02-20T03:00:36-02:00",
        "status": "done"
      }
    },
    {
      "type": "snapshots",
      "id": 2699,
      "attributes": {
        "name": "backup",
        "description": "description test",
        "uuid": "43a281df-2f1c-91c8-91e8-6ad5e6a24598",
        "taken_at": "2015-02-20T03:00:45-02:00",
        "status": "done"
      }
    }
  ],
  "links": {
    "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots?page%5Bnumber%5D=2&page%5Bsize%5D=1",
    "first": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots?page%5Bnumber%5D=1&page%5Bsize%5D=1",
    "prev": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots?page%5Bnumber%5D=1&page%5Bsize%5D=1",
    "next": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots?page%5Bnumber%5D=3&page%5Bsize%5D=1",
    "last": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots?page%5Bnumber%5D=4&page%5Bsize%5D=1"
  },
  "meta": {
    "total": 4
  }
}

Detalhes do snapshot

Exibe as informações de um snapshot.

Parâmetro Descrição Retornado por padrão
name Nome dado ao snapshot, fornecido ao criar um novo snapshot Sim
description Descrição dada ao snapshot, fornecida ao criar um novo snapsthot Sim
uuid Identificador único, gerado no momento da criação do snapshot Sim
taken_at Data em que o snapshot foi tirado no servidor Sim
status
  • creating (Processando snapshot)
  • done (Snapshot gerado com sucesso)
  • removing (Removendo snapshot)
  • reverting (Restaurando o snapshot)
  • waiting_deletion (Aguardando remoção)
  • error (Erro no snapshot)
Sim
GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2695

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": "snapshots",
    "id": 2695,
    "attributes": {
      "name": "2015-02-20_0300",
      "description": null,
      "uuid": "0efb8d00-5f0b-00bb-2cdf-6da4b03302b2",
      "taken_at": "2015-02-20T03:00:29-02:00",
      "status": "done"
    },
    "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/snapshots/2695"
  },
  "meta": {
    "actions": [
      "revert"
    ]
  }
}

Criar snapshot

Criar um novo snapshot do servidor.

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

Parâmetros:

Parâmetro Descrição Exemplo Obrigatório
name Nome do snapshot snap3 Sim
description Descrição do snapshot mysnapshot Não
1
2
3
4
5
6
7
8
9
{
  "data": {
    "type": "snapshots",
    "attributes": {
      "name": "snap3",
      "description": "mysnapshot"
    }
  }
}

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": "snapshots",
    "id": 2695,
    "attributes": {
      "name": "snap3",
      "description": "mysnapshot",
      "uuid": "0efb8d00-5f0b-00bb-2cdf-6da4b03302b2",
      "taken_at": "2015-02-20T03:00:29-02:00",
      "status": "done"
    },
    "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/snapshots/2695"
  },
  "meta": {
    "actions": [
      "revert"
    ]
  }
}

Excluir snapshot

Exibe detalhes de um determinado snapshot.

DELETE:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2436

Código HTTP: 202

Ações

Ações são os eventos de snapshot disponíveis para serem executados (por exemplo, restaurar um snapshot.)

Listagem das Ações

Exibe todas as ações para um determinado snapshot.

GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions

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
{
  "data": [
    {
      "type": "actions",
      "id": 8,
      "attributes": {
        "resource_type": "snapshots",
        "resource_id": "2702",
        "action": "revert",
        "status": "done"
      }
    },
    {
      "type": "actions",
      "id": 9,
      "attributes": {
        "resource_type": "snapshots",
        "resource_id": "2702",
        "action": "revert",
        "status": "new"
      }
    }
  ],
  "links": {
    "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions?page%5Bnumber%5D=2&page%5Bsize%5D=1",
    "first": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "prev": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "next": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions?page%5Bnumber%5D=3&page%5Bsize%5D=2",
    "last": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions?page%5Bnumber%5D=3&page%5Bsize%5D=2"
  },
  "meta": {
    "total": 6
  }
}

Detalhes da ação

Exibe detalhes sobre uma ação de snapshot.

Parâmetro Descrição Retornado por padrão
resource_type Nome do tipo do recurso. Sim
resource_id O id do recurso. Sim
action A ação criada. Sim
status

Status atual da ação.

  • new
  • running
  • done
  • failed
Sim
GET:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions/1

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "data": {
    "type": "actions",
    "id": 6,
    "attributes": {
      "resource_type": "snapshots",
      "resource_id": "2702",
      "action": "revert",
      "status": "new"
    },
    "links": {
      "self": "https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions/6"
    }
  }
}

Criar uma ação

Cria uma ação para um determinado snapshot.

POST:
• https://DOMINIO/v1/cloud/servers/SERVER_NAME/snapshots/2702/actions

Parâmetros:

Parâmetro Descrição Exemplo Obrigatório
resource_type Nome do tipo do recurso. ‘snapshots’ Sim
resource_id O id do recurso que deseja criar a ação. 2702 Sim
action A ação que deseja criar. 'revert' Sim
1
2
3
4
5
6
7
8
9
10
{
  "data":{
    "type": "actions",
    "attributes": {
      "resource_id": "2702",
      "resource_type": "snapshots",
      "action":"revert"
    }
  }
}

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "data": {
    "type": "actions",
    "id": 42,
    "attributes": {
      "resource_type": "snapshots",
      "resource_id": "2702",
      "action": "revert",
      "status": "new"
    },
    "links": {
      "self": "https://DOMINIO/v1/servers/SERVER_NAME/snapshots/2702/actions/42"
    }
  }
}