Criação de um ponto de restauração
Função
Esta API é usada para fazer backup de um cofre e gerar um ponto de restauração.
URI
POST /v3/{project_id}/checkpoints
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token de usuário. O token 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 |
|---|---|---|---|
| checkpoint | Sim | VaultBackup object | Parâmetros para fazer backup do cofre |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Parâmetros | Não | CheckpointParam object | Parâmetros |
| vault_id | Sim | String | ID do cofre |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| auto_trigger | Não | Boolean | Se o acionamento automático está ativado. Os valores possíveis são true (sim) e false (não). Padrão: false |
| description | Não | String | Descrição do backup Mínimo: 0 Máximo: 255 |
| incremental | Não | Boolean | Se o backup é um backup incremental. Os valores possíveis são true (sim) e false (não). Padrão: true |
| name | Não | String | Nome do backup, que pode conter apenas dígitos, letras, sublinhados (_) e hifens (-) Mínimo: 1 Máximo: 64 |
| resources | Não | Array of strings | Lista UUID de recursos a serem copiados |
| resource_details | Não | Array of Resource objects | Detalhes do recurso |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| extra_info | Não | ResourceExtraInfo object | Nome do cofre |
| id | Sim | String | ID do tipo de recurso do cofre |
| name | Não | String | Nome do recurso a ser copiado. O valor consiste de 0 a 255 caracteres. Mínimo: 0 Máximo: 255 |
| type | Sim | String | [Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2] (tag:hws,hws_hk) |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| exclude_volumes | Não | Array of strings | IDs dos discos dos quais não será feito backup. Este parâmetro é usado quando os servidores são adicionados a um cofre, que inclui todos os discos do servidor. Mas alguns discos não precisam ser copiados. Ou no caso de um servidor ter sido adicionado anteriormente e alguns discos neste servidor não precisarem ser copiados. |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| checkpoint | CheckpointCreate object | Informações do ponto de restauração |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| created_at | String | Tempo de criação, por exemplo, 2020-02-05T10:38:34.209782 |
| id | String | ID do ponto de restauração |
| project_id | String | ID do projeto |
| status | String | Estado Valores de enumeração:
|
| vault | CheckpointPlanCreate object | Informações do cofre |
| extra_info | CheckpointExtraInfoResp object | Informação ampliada |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID do cofre |
| name | String | Nome do cofre |
| resources | Array of CheckpointResourceResp objects | Objetos de backup |
| skipped_resources | Array of CheckpointCreateSkippedResource objects | Recursos ignorados durante o backup |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| extra_info | String | Informação extra do recurso |
| id | String | ID do recurso a ser copiado |
| name | String | Nome do recurso a ser copiado |
| protect_status | String | Estado protegido Valores de enumeração:
|
| resource_size | String | Capacidade alocada para o recurso associado, em GB |
| type | String | Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2 |
| backup_size | String | Tamanho do backup |
| backup_count | String | Número de backups |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID do recurso |
| type | String | Tipo de recurso |
| name | String | Nome do recurso |
| code | String | Para obter detalhes, consulte Códigos de erro. |
| reason | String | Razão para o salto. Por exemplo, o recurso está sendo feito backup. |
Exemplo de solicitações
Criar backups
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints
{
"checkpoint" : {
"parameters" : {
"auto_trigger" : true,
"description" : "backup_description",
"incremental" : true,
"name" : "backup_name",
"resources" : [ "94eba8b2-acc9-4d82-badc-127144cc5526" ]
},
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
}
} Exemplo de respostas
Código de status: 200
OK
{
"checkpoint" : {
"status" : "protecting",
"created_at" : "2019-05-10T07:59:12.733403",
"vault" : {
"skipped_resources" : [ ],
"id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
"resources" : [ {
"name" : "ecs-1f0f-0002",
"resource_size" : "40",
"protect_status" : "available",
"type" : "OS::Nova::Server",
"id" : "94eba8b2-acc9-4d82-badc-127144cc5526",
"extra_info" : null
} ],
"name" : "vault-be94"
},
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
"id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
"extra_info" : {
"retention_duration" : -1,
"name" : "backup_name",
"description" : "backup_description"
}
}
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
Códigos de erro
Consulte Códigos de erro.
