Creación de un punto de restauración
Función
Esta API se utiliza para hacer una copia de seguridad de un almacén y generar un punto de restauración.
URI
POST /v3/{project_id}/checkpoints
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID de proyecto |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
checkpoint |
Sí |
VaultBackup object |
Parámetros para realizar una copia de seguridad del almacén |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
parameters |
No |
CheckpointParam object |
Parámetros |
|
vault_id |
Sí |
String |
ID de almacén |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
auto_trigger |
No |
Boolean |
Si la activación automática está activada. Los valores posibles son true (yes) y false (no). Predeterminado: false |
|
description |
No |
String |
Descripción de la copia de respaldo Mínimo: 0 Máximo: 255 |
|
incremental |
No |
Boolean |
Si la copia de respaldo es una copia de respaldo incremental. Los valores posibles son true (yes) y false (no). Predeterminado: true |
|
name |
No |
String |
Nombre de copia de seguridad, que puede contener solo dígitos, letras, guiones bajos (_), y guiones (-) Mínimo: 1 Máximo: 64 |
|
resources |
No |
Array of strings |
Lista de UUID de recursos de los que se va a hacer una copia de seguridad |
|
resource_details |
No |
Array of Resource objects |
Detalles del recurso |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
extra_info |
No |
ResourceExtraInfo object |
Nombre de almacén |
|
id |
Sí |
String |
ID del tipo de recurso de almacén |
|
name |
No |
String |
Nombre del recurso al que se va a hacer una copia de seguridad. El valor consta de 0 a 255 caracteres. Mínimo: 0 Máximo: 255 |
|
type |
Sí |
String |
Tipo del recurso que se va a hacer una copia de seguridad, que puede ser OS::Nova::Server, OS::Cinder::Volume, o OS::Sfs::Turbo |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
exclude_volumes |
No |
Array of strings |
ID de los discos de los que no se realizará una copia de seguridad. Este parámetro se utiliza cuando se agregan servidores a un almacén, que incluye todos los discos de servidor. Pero algunos discos no necesitan ser respaldados. O en caso de que se haya agregado un servidor previamente y no sea necesario realizar copias de seguridad de algunos discos de este servidor. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
checkpoint |
CheckpointCreate object |
Información de punto de restaruración |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
created_at |
String |
Tiempo de creación, por ejemplo, 2020-02-05T10:38:34.209782 |
|
id |
String |
ID de punto de restauración |
|
project_id |
String |
ID de proyecto |
|
status |
String |
Estado Valores de enumeración:
|
|
vault |
CheckpointPlanCreate object |
Información del almacén |
|
extra_info |
CheckpointExtraInfoResp object |
Información extendida |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de almacén |
|
name |
String |
Nombre de almacén |
|
resources |
Array of CheckpointResourceResp objects |
Objetos de copia de seguridad |
|
skipped_resources |
Array of CheckpointCreateSkippedResource objects |
Recursos omitidos durante la copia de respaldo |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
extra_info |
String |
Información adicional del recurso |
|
id |
String |
ID del recurso al que se va a realizar una copia de seguridad |
|
name |
String |
Nombre del recurso al que se va a hacer una copia de seguridad |
|
protect_status |
String |
Estado protegido Valores de enumeración:
|
|
resource_size |
String |
Capacidad asignada para el recurso asociado, en GB |
|
type |
String |
Tipo del recurso que se va a hacer una copia de seguridad, que puede ser OS::Nova::Server, OS::Cinder::Volume, o OS::Sfs::Turbo |
|
backup_size |
String |
Tamaño de copia de respaldo |
|
backup_count |
String |
Cantidad de copias de respaldo |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de recurso |
|
type |
String |
Tipo de recurso |
|
name |
String |
Nombre de recurso |
|
code |
String |
Para obtener más información, consulte Códigos de error. |
|
reason |
String |
Motivo de la omisión. Por ejemplo, se está realizando una copia de seguridad del recurso. |
Solicitudes de ejemplo
Creación de copias de seguridad
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"
}
}
Ejemplo de respuestas
Código de estado: 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 estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
Códigos de error
Consulte Códigos de error.