Actualización de un disco de EVS
Función
Esta API se utiliza para actualizar un disco de EVS.
Método de invocación
Para obtener más información, consulte Invocación de las API.
URI
PUT /v3/{project_id}/volumes/{volume_id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. |
| volume_id | Sí | String | El ID del disco. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | El token de 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. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| volume | Sí | CinderUpdateVolumeOption object | La información del disco que se va a actualizar. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| name | No | String | El nombre del disco. Puede ingresar hasta 64 caracteres. |
| description | No | String | La descripción del disco. Puede ingresar hasta 85 caracteres. |
| metadata | No | Map<String,String> | Los metadatos del disco. La longitud de key o value bajo metadata no puede contener más de 255 bytes. |
| display_description | No | String | La descripción del disco. Puede especificar description o display_description. Si se especifican ambos, se utiliza el valor description. Puede ingresar hasta 85 caracteres. |
| display_name | No | String | El nombre del disco. Puede especificar name o display_name. Si se especifican ambos, se utiliza el valor name. Puede ingresar hasta 64 caracteres. |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | El ID del disco. |
| links | Array of Link objects | El URI del disco. |
| name | String | El nombre del disco. |
| status | String | El estado del disco. Para obtener más información, consulte Estado del disco de EVS. |
| attachments | Array of VolumeAttachment objects | La información de adjuntos. |
| availability_zone | String | La AZ a la que pertenece el disco. |
| disaster_recovery_azs | Array of strings | Las AZ a las que pertenece el disco de DR. |
| bootable | String | Si el disco es arrancable. true: El disco es arrancable. false: El disco no es arrancable. |
| encrypted | Boolean | Actualmente, este campo no se admite. |
| created_at | String | La hora en que se creó el disco. Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| description | String | La descripción del disco. |
| volume_type | String | El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD o GPSSD2.
Si el tipo de disco especificado no está disponible en la AZ, el disco no se creará. |
| replication_status | String | El campo reservado. |
| consistencygroup_id | String | El ID del grupo de consistencia al que pertenece el disco. |
| source_volid | String | El ID del disco de origen. Actualmente, este campo no se admite. |
| snapshot_id | String | El ID de la instantánea. |
| metadata | VolumeMetadata object | Los metadatos. |
| size | Integer | El tamaño del disco, en GiB. |
| user_id | String | El ID del usuario que utiliza el disco. |
| updated_at | String | La hora en que se actualizó el disco. |
| shareable | Boolean | Si el disco es compartible. Nota: Este campo ha sido obsoleto. Utilice multiattach. |
| multiattach | Boolean | Si el disco es compartible. true: El disco es compartible. false: El disco no es compartible. |
| storage_cluster_id | String | El campo reservado. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| href | String | Definición El enlace de acceso directo correspondiente. Rango N/D |
| rel | String | Definición El nombre del marcador del enlace de acceso directo. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| attached_at | String | Definición La hora en que se conectó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| attachment_id | String | Definición El ID del adjunto. Rango N/D |
| device | String | Definición El nombre del dispositivo. Rango N/D |
| host_name | String | Definición El nombre del host físico que aloja el servidor en la nube al que está conectado el disco. Rango N/D |
| id | String | Definición El ID del recurso conectado. Rango N/D |
| server_id | String | Definición El ID del servidor al que está conectado el disco. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| __system__cmkid | String | Definición El ID del CMK de encriptación en metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes. Rango Utilice una solicitud HTTPS para obtener el ID de clave. Para obtener más información, consulte Consulta de la lista de claves. |
| __system__encrypted | String | Definición El campo de encriptación en metadata. Si este parámetro no aparece, el disco no está encriptado. Rango
|
| hw:passthrough | String | Definición El parámetro que describe el tipo de dispositivo de disco en metadata. Si este parámetro no aparece, el tipo de dispositivo de disco es VBD. Rango
|
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 |
Ejemplos de solicitudes
PUT https://{endpoint}/v3/{project_id}/volumes/{volume_id}
{
"volume" : {
"name" : "test_volume",
"description" : "test"
}
} Ejemplos de respuestas
Código de estado: 200
OK
{
"volume" : {
"attachments" : [ ],
"availability_zone" : "az-dc-1",
"bootable" : "false",
"consistencygroup_id" : null,
"created_at" : "2016-05-25T02:38:40.392463",
"description" : "create for api test",
"encrypted" : false,
"id" : "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel" : "bookmark"
} ],
"metadata" : {
"volume_owner" : "openapi"
},
"name" : "openapi_vol01",
"replication_status" : "disabled",
"multiattach" : false,
"size" : 40,
"snapshot_id" : null,
"source_volid" : null,
"status" : "creating",
"updated_at" : null,
"user_id" : "39f6696ae23740708d0f358a253c2637",
"volume_type" : "SATA"
}
} Código de estado: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "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.