Creación de una instantánea de EVS
Función
Esta API se utiliza para crear una instantánea de EVS.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
POST /v2/{project_id}/snapshots
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
El ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
El token del usuario. Se puede obtener invocando 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 |
|---|---|---|---|
|
snapshot |
Sí |
CinderCreateSnapshotOption object |
La información de la instantánea que se va a crear. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
volume_id |
Sí |
String |
ID del disco de origen de la instantánea. Para obtener el ID del disco, véase Consulta de detalles sobre todos los discos. |
|
description |
No |
String |
La descripción de la instantánea. El valor puede ser null. Puede escribir hasta 85 caracteres. |
|
force |
No |
Boolean |
El indicador para crear forzosamente la instantánea. El valor predeterminado es false. Si el valor de este parámetro es false, no se pueden crear instantáneas forzosamente cuando el estado del disco es attaching. Si el valor de este parámetro es true, se pueden crear instantáneas forzosamente aunque el estado del disco sea attaching. |
|
metadata |
No |
Map<String,String> |
Los metadatos de la instantánea. |
|
name |
No |
String |
El nombre de la instantánea. Puede escribir hasta 64 caracteres.
NOTA:
Cuando se crea una copia de respaldo para un disco, también se crea una instantánea y se le asigna un nombre con el prefijo autobk_snapshot_. No se pueden realizar operaciones en dichas instantáneas. Por lo tanto, se recomienda no utilizar autobk_snapshot_ como prefijo de nombres de instantáneas para evitar inconvenientes. |
Parámetros de respuesta
Código de estado: 202
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
snapshot |
SnapshotSummary object |
La información de la instantánea. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
created_at |
String |
La hora en que se creó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
|
description |
String |
La descripción de la instantánea. |
|
id |
String |
El ID de la instantánea. |
|
metadata |
Map<String,String> |
Los metadatos de la instantánea. Si metadata contiene el campo __system__enableActive, la instantánea se genera automáticamente durante una copia de respaldo del servidor. |
|
name |
String |
El nombre de la instantánea. |
|
size |
Integer |
Tamaño de la instantánea, en GiB. |
|
status |
String |
El estado de la instantánea. Para obtener más detalles, consulte Estado de la instantánea de EVS. |
|
updated_at |
String |
La hora en que se actualizó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
|
volume_id |
String |
ID del disco de origen de la instantánea. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error |
Error object |
El mensaje de error devuelto si se produce un error. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
code |
String |
El código de error devuelto si se produce un error. Para obtener más detalles sobre los códigos de error y sus significados, consulte Códigos de errores. |
|
message |
String |
El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
Creación de una instantánea (Si el disco de EVS de origen está conectado, la instantánea no se puede crear a la fuerza.)
POST https://{endpoint}/v2/{project_id}/snapshots
{
"snapshot" : {
"name" : "snap-001",
"description" : "Daily backup",
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"force" : false,
"metadata" : { }
}
}
Ejemplo de respuestas
Código de estado: 202
Aceptado
{
"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 estado: 400
Error en la solicitud
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
202 |
Aceptado |
|
400 |
Error en la solicitud |
Códigos de error
Consulte Códigos de error.
