Actualización de información de instantáneas
Función
Esta API se utiliza para actualizar la información de una instantánea. Las instantáneas estándares solo se admiten en algunas regiones. Puede consultar las regiones admitidas en la consola.
Método de invocación
Para obtener más información, consulte Invocación de las API.
URI
PUT /v5/{project_id}/snapshots/{snapshot_id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | Definición El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. Restricciones N/D Rango N/D Valor predeterminado N/D |
| snapshot_id | Sí | String | Definición El ID de la instantánea. Puede invocar la API Consulta de detalles sobre instantáneas de EVS para obtener el ID de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Definición El token del usuario. Se puede obtener invocando 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. Restricciones N/D Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| snapshot | Sí | CinderUpdateSnapshotOptionV5 object | Definición La información de instantánea que se va a actualizar. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| snapshot | SnapshotDetailV5 object | Definición La información de la instantánea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID de la instantánea. Rango N/D |
| name | String | Definición El nombre de la instantánea. El sistema crea automáticamente las instantáneas cuyos nombres comienzan con el prefijo autobk_snapshot_ durante la creación de copia de respaldo. Estas instantáneas no se pueden eliminar ni utilizar para revertir los datos. Rango N/D |
| description | String | Definición Descripción de la instantánea. Rango N/D |
| created_at | String | Definición Hora en que se creó la instantánea. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX Rango N/D |
| updated_at | String | Definición Hora en que se actualizó la instantánea. Rango N/D |
| volume_id | String | Definición El ID del disco de origen de la instantánea. Rango N/D |
| size | String | Definición Tamaño de la instantánea, en GiB. Rango N/D |
| status | String | Definición El estado de la instantánea. Rango Para obtener más información, consulte Estado de la instantánea de EVS. |
| project_id | String | Definición El ID del proyecto. Rango N/D |
| enterprise_project_id | String | Definición El ID del proyecto empresarial al que pertenece la instantánea. Rango N/D |
| encrypted | Boolean | Definición Si la instantánea está encriptada. Rango N/D |
| cmk_id | String | Definición El ID de la clave de encriptación utilizada por el disco de origen de la instantánea. Rango N/D |
| category | String | Definición El tipo de instantánea. Rango standard o flash |
| availability_zone | String | Definición La AZ a la que pertenece la instantánea. Rango N/D |
| tags | Map<String,String> | Definición Las etiquetas de la instantánea. Rango N/D |
| instant_access | Boolean | Definición Si la restauración instantánea de instantáneas está habilitada. Rango true: habilitada. Solo los discos respaldados por SSD admiten esta función. false: deshabilitada. Las instantáneas con la restauración instantánea de instantáneas deshabilitada son instantáneas estándar. |
| retention_at | String | Definición La duración de la retención de instantáneas. Rango N/D |
| instant_access_retention_at | String | Definición La duración de la retención de la restauración instantánea de instantáneas. Una vez finalizada la duración de la retención, la restauración instantánea de instantáneas se deshabilita automáticamente para las instantáneas. Rango De forma predeterminada, el valor de este parámetro es el mismo que el de retention_at. |
| incremental | Boolean | Definición Si la instantánea es una instantánea incremental. Rango true o false |
| snapshot_type | String | Definición El origen de creación de la instantánea. Rango auto: creado automáticamente user: creado manualmente copy: replicado |
| progress | String | Definición El progreso de la creación de la instantánea, en porcentaje. Rango N/D |
| encrypt_algorithm | String | Definición El algoritmo de encriptación de instantáneas. Rango N/D |
| snapshot_chains | Array of SnapshotChains objects | Definición La cadena de instantáneas a la que pertenece la instantánea. Rango N/D |
| snapshot_group_id | String | Definición El ID del grupo de coherencia de instantáneas al que pertenece la instantánea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID de la cadena de instantáneas. Rango N/D |
| availability_zone | String | Definición La AZ del disco al que pertenece la cadena de instantáneas. Rango N/D |
| snapshot_count | Integer | Definición La cantidad de instantáneas de la cadena de instantáneas. Rango ≥ 0 |
| capacity | Integer | Definición El uso del almacenamiento de la cadena de instantáneas. Rango El valor es mayor o igual que 0. |
| project_id | String | Definición El ID del proyecto. Rango N/D |
| volume_id | String | Definición El ID del disco al que pertenece la cadena de instantáneas. Rango N/D |
| category | String | Definición El tipo de cadena de instantáneas. Rango El valor puede ser standard o standard_copy. |
| created_at | String | Definición La fecha y hora de creación. Rango N/D |
| updated_at | String | Definición La fecha y hora de actualización. Rango N/D |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Error object | Definición La información de error devuelta si se produce un error. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| code | String | Definición El código de error devuelto si se produce un error. Rango Para obtener más información sobre el código de error, consulte Códigos de error. |
| message | String | Definición El mensaje de error devuelto si se produce un error. Rango N/D |
Ejemplo de solicitudes
PUT https://{endpoint}/v5/{project_id}/snapshots/{snapshot_id}
{
"snapshot" : {
"name" : "snap-001",
"description" : "Daily backup",
"instant_access" : false
}
} Ejemplo de respuestas
Código de estado: 200
OK
{
"snapshot" : {
"id" : "308c213b-5e09-478e-a772-c81b20749fea",
"status" : "available",
"project_id" : "7c08fb7726964bf5b70a1f55a4cd6017",
"size" : 1,
"name" : null,
"description" : null,
"cmk_id" : null,
"encrypted" : false,
"created_at" : "2023-07-03T08:53:13.373010",
"updated_at" : "2023-07-03T08:53:13.578010",
"volume_id" : "66016b8d-b850-4afb-b2a4-d5903e9ffb59",
"enterprise_project_id" : "0",
"category" : "flash",
"availability_zone" : "az2.dc2",
"tags" : { },
"instant_access" : true,
"instant_access_retention_at" : "2023-07-07T08:53:13.373010",
"retention_at" : "2023-07-07T08: 53: 13.373010"
}
} Código de estado: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.
