Criação de um snapshot do EVS
Função
Esta API é usada para criar um snapshot do EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
POST /v2/{project_id}/snapshots
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
O ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
O token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
snapshot |
Sim |
CinderCreateSnapshotOption object |
As informações do snapshot a ser criado. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
volume_id |
Sim |
String |
O ID do disco de origem do snapshot. Para obter o ID do disco, consulte Consulta de detalhes sobre todos os discos. |
description |
Não |
String |
A descrição do snapshot. O valor pode ser null. Você pode inserir até 85 caracteres. |
force |
Não |
Boolean |
O sinalizador para a criação forçada do snapshot. O valor padrão é false. Se esse valor de parâmetro for false, os snapshots não poderão ser criados à força quando o status do disco estiver false Se esse valor de parâmetro for true, os snapshots poderão ser criados à força mesmo quando o status do disco estiver attaching. |
metadata |
Não |
Map<String,String> |
Os metadados do snapshot. |
name |
Não |
String |
O nome do snapshot. Você pode inserir até 64 caracteres.
NOTA:
Quando um backup é criado para um disco, um snapshot também será criado e nomeado com o prefixo autobk_snapshot_. As operações não podem ser executadas em tais snapshots. Portanto, é aconselhável não usar autobk_snapshot_ como o prefixo de nomes de snapshots para evitar qualquer inconveniente. |
Parâmetros de resposta
Código de status: 202
Parâmetro |
Tipo |
Descrição |
---|---|---|
snapshot |
SnapshotSummary object |
As informações do snapshot. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
created_at |
String |
A hora em que o snapshot foi criado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
description |
String |
A descrição do snapshot. |
id |
String |
O ID do snapshot. |
metadata |
Map<String,String> |
Os metadados do snapshot. Se metadata contiver o campo __system__enableActive, o snapshot será um snapshot gerado automaticamente e criado durante um backup do servidor. |
name |
String |
O nome do snapshot. |
size |
Integer |
O tamanho do snapshot, em GiB. |
status |
String |
O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS. |
updated_at |
String |
A hora em que o snapshot foi atualizado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
volume_id |
String |
O ID do disco de origem do snapshot. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
A mensagem de erro retornada se ocorrer um erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
O código de erro retornado se ocorrer um erro. Para obter detalhes sobre códigos de erro e seus significados, consulte Códigos de erro. |
message |
String |
A mensagem de erro retornada se ocorrer um erro. |
Exemplo de solicitações
Criar um snapshot (se o disco EVS de origem estiver anexado, o snapshot não poderá ser criado à força.)
POST https://{endpoint}/v2/{project_id}/snapshots { "snapshot" : { "name" : "snap-001", "description" : "Daily backup", "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "force" : false, "metadata" : { } } }
Exemplo de respostas
Código de status: 202
Accepted
{ "snapshot" : { "status" : "creating", "description" : "Daily backup", "created_at" : "2013-02-25T03:56:53.081642", "metadata" : { }, "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "size" : 1, "id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d", "name" : "snap-001", "updated_at" : "2013-02-25T03:56:53.081642" } }
Código de status: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Códigos de status
Código de status |
Descrição |
---|---|
202 |
Accepted |
400 |
Bad Request |
Códigos de erro
Consulte Códigos de erro.