Creación de discos EVS
Función
Esta API se utiliza para crear uno o varios discos EVS.
URI
- Formato URI
- Descripción del parámetro
Parámetro
Obligatorio
Descripción
project_id
Sí
Especifica el ID del proyecto.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
Solicitud
- Descripción del parámetro
Parámetro
Tipo
Obligatorio
Descripción
volume
Object
Sí
Especifica la información de los discos que se van a crear. Para obtener más información, consulte Parámetros en el campo de volumen.
- Parámetros en el campo de volume
Parámetro
Tipo
Obligatorio
Descripción
availability_zone
String
Sí
Especifica la zona de disponibilidad donde desea crear el disco. Si el zona de disponibilidad no existe, el disco no se creará.
NOTA:Para obtener más información sobre cómo obtener el zona de disponibilidad, consulte Consulta de todas las AZ.
source_volid
String
No
Especifica el ID del disco de origen. Si se especifica este parámetro, el disco se clona de un disco existente. Actualmente, esta función no se admite.
description
String
No
Especifica la descripción del disco.
snapshot_id
String
No
Especifica el ID de la instantánea. Si se especifica este parámetro, el disco se crea a partir de una instantánea.
NOTA:Para obtener más información sobre cómo obtener el ID de instantánea, consulte Consulta de detalles acerca de instantáneas de EVS.
size
Integer
Sí
Especifica el tamaño del disco, en GB. Su valor puede ser el siguiente:- Disco del sistema: 1 GB a 1024 GB
- Disco de datos: 10 GB a 32768 GB
Este parámetro es obligatorio cuando se crea un disco vacío. Puede especificar el valor del parámetro según sea necesario dentro del rango de valores.
Este parámetro es obligatorio cuando se crea el disco a partir de una instantánea. Asegúrese de que el tamaño del disco es mayor o igual que el tamaño de la instantánea.
Este parámetro es obligatorio cuando se crea el disco a partir de una imagen. Asegúrese de que el tamaño del disco es mayor o igual a la capacidad mínima de disco requerida por min_disk en los atributos de imagen.
name
String
No
Especifica el nombre del disco.
imageRef
String
No
Especifica el ID de imagen. Si se especifica este parámetro, el disco se crea a partir de una imagen.
volume_type
String
No
Especifica el tipo de disco.
Currently, the value can be SSD, GPSSD, or SAS.- SSD: specifies the ultra-high I/O disk type.
- GPSSD: specifies the general purpose SSD disk type.
- SAS: specifies the high I/O disk type.
Si el tipo de disco especificado no está disponible en el zona de disponibilidad, el disco no se creará.
NOTA:- Para obtener más información acerca de los tipos de disco, consulte Tipos de disco y rendimiento.
metadata
Object
No
Especifica los metadatos del disco.
Para obtener más información sobre metadata, consulte Parámetros en el campo de metadatos. La tabla muestra algunos campos. También puede especificar otros campos en función de los requisitos de creación de disco.
NOTA:Los valores de parámetro en metadata no pueden ser null.
source_replica
String
No
Especifica el ID del disco de origen. Si se especifica este parámetro, el disco se clona de un disco existente. Actualmente, esta función no se admite.
consistencygroup_id
String
No
Se muestra información similar a la siguiente:
multiattach
Boolean
No
Especifica si el disco es compartible. El valor predeterminado es false.- true: especifica un disco compartido.
- false: especifica un disco no compartido.
No se admite la especificación de dos de los source_volid, snapshot_id, and imageRef.
- Parámetros en el campo de metadata
Parámetro
Tipo
Obligatorio
Descripción
__system__encrypted
String
No
Especifica el campo de encriptación en metadata. El valor puede ser 0 (no cifrado) o 1 (cifrado).
Si este parámetro no existe, el disco no se cifrará de forma predeterminada.
__system__cmkid
String
No
Especifica el ID de 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.
NOTA:Para obtener más información sobre cómo obtener el ID de CMK, consulte Consulta de la lista de CMK.
hw:passthrough
String
No
- Si este parámetro se establece en true, el tipo de dispositivo de disco es SCSI, es decir, Small Computer System Interface (SCSI), que permite que los SO ECS accedan directamente a los medios de almacenamiento subyacentes y admite comandos de reserva SCSI.
- Si este parámetro se establece en false, el tipo de dispositivo de disco será VBD, que solo admite comandos simples de lectura/escritura SCSI.
- Si este parámetro no aparece, el tipo de dispositivo de disco es VBD.
NOTA:
Si el parámetro shareable se establece en true y el parámetro hw:passthrough no se especifica, se crean discos VBD compartidos.
full_clone
String
No
Si el disco se crea a partir de una instantánea y es necesario utilizar la clonación vinculada, establezca este parámetro en 0.
La tabla anterior proporciona solo algunos parámetros en metadata para su referencia. También puede especificar otros campos en función de los requisitos de creación de disco.
- Si el disco se crea a partir de una instantánea, no se admiten __system__encrypted y __system__cmkid, y el disco recién creado tiene el mismo atributo de encriptación que el disco de origen de la instantánea.
- Si el disco se crea a partir de una imagen, no se admiten __system__encrypted y __system__cmkid, y el disco recién creado tiene el mismo atributo de encriptación que el de la imagen.
- Si el disco se crea a partir de una instantánea, no se admite hw:passthrough y el disco recién creado tiene el mismo tipo de dispositivo que el disco de origen de la instantánea.
- Si el disco se crea a partir de una imagen, no se admite hw:passthrough y el tipo de dispositivo del disco recién creado es VBD.
- Solicitud de ejemplo
{ "volume": { "name": "openapi_vol01", "imageRef": "027cf713-45a6-45f0-ac1b-0ccc57ac12e2", "availability_zone": "az-dc-1", "description": "create for api test", "volume_type": "SAS", "metadata": { "volume_owner": "openapi" }, "multiattach": false, "size": 40 }, }
Respuesta
- Descripción del parámetro
Parámetro
Tipo
Descripción
volume
Object
Especifica la información de los discos creados. Para obtener más información, consulte Parámetros en el campo volumes.
error
Object
Especifica el mensaje de error devuelto cuando se produce un error. Para obtener más información, consulte Parámetros en el campo de error.
- Parámetros en el campo volumes
Parámetro
Tipo
Descripción
id
String
Especifica el ID de disco.
links
list
Especifica el URI del disco. Para obtener más información, consulte Parámetros en el campo de enlaces.
name
String
Especifica el nombre del disco.
status
String
Especifica el estado del disco. Para más detalles, consulte Estado de disco EVS.
attachments
list
Especifica la información de datos adjuntos del disco. Para obtener más información, consulte Parámetros en el campo de datos adjuntos.
availability_zone
String
Especifica la zona de disponibilidad al que pertenece el disco.
bootable
String
Especifica si el disco es arrancable.- true: especifica un disco de arranque.
- false: especifica un disco no arrancable.
encrypted
Boolean
Se muestra información similar a la siguiente:
created_at
String
Especifica la hora a la que se creó el disco.
description
String
Especifica la descripción del disco.
volume_type
String
Especifica el tipo de disco.
Currently, the value can be SSD, GPSSD, or SAS.- SSD: specifies the ultra-high I/O disk type.
- GPSSD: specifies the general purpose SSD disk type.
- SAS: specifies the high I/O disk type.
replication_status
String
Especifica el ID de la instantánea.
consistencygroup_id
String
Especifica el identificador del grupo de consistencia al que pertenece el disco.
source_volid
String
Especifica el ID del disco de origen.
snapshot_id
String
Especifica el ID de la instantánea.
metadata
Object
Especifica los metadatos del disco. Para obtener más información, consulte Parámetros en el campo de metadatos.
size
Integer
Especifica el tamaño del disco, en GB.
user_id
String
Campo Reservado
updated_at
String
Especifica la hora a la que se actualizó el disco.
shareable
Boolean
Especifica si el disco es compartible.
NOTA:Este campo ya no se utiliza. Usa multiattach.
multiattach
Boolean
Especifica si el disco es compartible.- true: especifica un disco compartido.
- false: especifica un disco no compartido.
- Parámetros en el campo links
Parámetro
Tipo
Descripción
href
String
Especifica el enlace de acceso directo correspondiente.
rel
String
Especifica el nombre del marcador de enlace de acceso directo.
- Parámetros en el campo attachments
Parámetro
Tipo
Descripción
server_id
String
Especifica el ID del servidor al que está conectado el disco.
attachment_id
String
Especifica ID de la información de datos adjuntos.
attached_at
String
Especifica la hora a la que se ha conectado el disco.
host_name
String
Especifica el nombre del host físico que aloja el servidor al que está conectado el disco.
volume_id
String
Especifica el ID de disco.
device
String
Especifica el nombre del dispositivo.
id
String
Especifica el ID del recurso adjunto.
- Parameters in the metadata field
Parameter
Type
Description
__system__encrypted
String
Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.- 0: indicates the disk is not encrypted.
- 1: indicates the disk is encrypted.
- If this parameter does not appear, the disk is not encrypted by default.
__system__cmkid
String
Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.
hw:passthrough
String
Specifies the parameter that describes the disk device type in metadata. The value can be true or false.- If this parameter is set to true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.
- If this parameter is set to false, the disk device type is VBD (the default type), that is, Virtual Block Device (VBD), which supports only simple SCSI read/write commands.
- If this parameter does not appear, the disk device type is VBD.
full_clone
String
Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method.
orderID
String
Specifies the parameter that describes the disk billing mode in metadata.
If this parameter is specified, the disk is billed on a yearly/monthly basis. If this parameter is not specified, the disk is billed on a pay-per-use basis.
- Parámetros en el campo de error
Parámetro
Tipo
Descripción
message
String
Especifica el mensaje de error devuelto cuando se produce un error.
code
String
Especifica el código de error devuelto cuando se produce un error.
Para obtener más información sobre el código de error, consulte Códigos de error.
- Ejemplo de respuesta
{ "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": "SAS" } }
o
{ "error": { "message": "XXXX", "code": "XXX" } }
En el ejemplo anterior, error indica un error general, por ejemplo, badRequest o itemNotFound. Un ejemplo es el siguiente:
{ "badRequest": { "message": "XXXX", "code": "XXX" } }
Códigos de error
Para más detalles, consulte Códigos de error.