Creación de discos de EVS
Función
Esta API se utiliza para crear discos de EVS.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
POST /v3/{project_id}/volumes
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 |
---|---|---|---|
volume |
Sí |
CinderCreateVolumeOption object |
La información del disco que se va a crear. Nota: No se admite la especificación conjunta de dos de los campos source_volid, snapshot_id y imageRef. |
OS-SCH-HNT:scheduler_hints |
No |
El parámetro de programación. Se admite el campo dedicated_storage_id, que indica que los discos se puede crear en los grupos de almacenamiento de DSS. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
availability_zone |
Sí |
String |
La zona de disponibilidad donde desea crear el disco. Si la AZ especificada no existe o es diferente de la AZ a la que pertenece la copia de respaldo, el disco no se va a crear. |
consistencygroup_id |
No |
String |
El ID del grupo de consistencia. Si se especifica este parámetro, el disco pertenece a este grupo de coherencia. Esta función no se encuentra disponible actualmente. |
description |
No |
String |
La descripción del disco. Puede escribir hasta 85 caracteres. |
imageRef |
No |
String |
El ID de la imagen. Si se especifica este parámetro, el disco se crea a partir de una imagen.
NOTA:
Los discos del sistema de Bare Metal Server (BMS) no se pueden crear a partir de imágenes de BMS. Para obtener detalles sobre cómo obtener el ID de imagen, véase Consulta de imágenes. |
metadata |
No |
VolumeMetadata object |
Los metadatos del disco. La longitud de key o value bajo metadata no puede contener más de 255 bytes. El campo metadata solo muestra algunos parámetros. Puede especificar otros parámetros en función de sus necesidades. value de un par de clave-valor de metadata no puede ser nulo. |
multiattach |
No |
Boolean |
Si el disco se puede compartir. El valor predeterminado es false. true: el disco se puede compartir. false: el disco no se puede compartir. Para más detalles, consulte |
name |
No |
String |
El nombre del disco. Puede escribir hasta 64 caracteres. |
size |
No |
Integer |
El tamaño del disco, en GiB. Las restricciones son las siguientes: Disco del sistema: 1 GiB a 1,024 GiB Disco de datos: 10 GiB a 32,768 GiB Este parámetro es obligatorio cuando se crea un disco vacío. Si crea el disco a partir de una instantánea, este parámetro es obligatorio y el tamaño del disco debe ser mayor o igual que el tamaño de la instantánea. Si crea el disco a partir de una imagen, este parámetro es obligatorio y el tamaño del disco debe ser mayor o igual que la capacidad mínima requerida por el atributo de imagen min_disk. |
snapshot_id |
No |
String |
El ID de la instantánea. Si se especifica este parámetro, el disco se crea a partir de una instantánea. |
source_replica |
No |
String |
Este parámetro indica que el disco está clonado desde otro disco. Esta función no se encuentra disponible actualmente. |
source_volid |
No |
String |
El ID del disco de origen. Si se especifica este parámetro, el disco se clona de un disco existente. Esta función no está soportada actualmente. |
volume_type |
Sí |
String |
El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2.
NOTA:
Cuando cree un disco a partir de una instantánea, asegúrese de que el tipo de disco del nuevo disco coincida con el del disco de origen de la instantánea. Para obtener detalles acerca de los tipos de disco, consulte Valores de enumeración:
|
iops |
No |
Integer |
Las IOPS configuradas. Este parámetro solo es obligatorio cuando se crea un disco de SSD V2 de uso general o un disco de SSD V2 extremo.
NOTA:
|
throughput |
No |
Integer |
El throughput configurado, en la unidad de MiB/s. Este parámetro solo es obligatorio cuando se crea un disco de SSD V2 de uso general.
NOTA:
- Para conocer el rango de throughput de los discos de SSD V2 de uso general, consulte la tabla de Datos de rendimiento de EVS en Tipos de disco y rendimiento.
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
__system__cmkid |
No |
String |
El ID de CMK de encriptación de metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes.
NOTA:
Utilice una solicitud de HTTPS para obtener el ID de clave. Para obtener más detalles, consulte Consulta de la lista de claves. |
__system__encrypted |
No |
String |
El campo de encriptación de metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si este parámetro no aparece, el disco no está cifrado. |
full_clone |
No |
String |
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. |
hw:passthrough |
No |
String |
Si este parámetro se establece en true, el tipo de dispositivo de disco es SCSI, lo que permite que los sistemas operativos de ECS accedan directamente a los medios de almacenamiento subyacentes. Se admiten comandos de reserva SCSI. Si este parámetro se establece en false, el tipo de dispositivo de disco es VBD, que también es el tipo predeterminado. VBD solo admite los comandos simples de lectura/escritura de SCSI. Si este parámetro no está disponible, el tipo de dispositivo de disco es VBD. |
Parámetros de respuesta
Código de estado: 202
Parámetro |
Tipo |
Descripción |
---|---|---|
volume |
CreateVolumeDetail object |
La información del disco creado. |
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 detalles, consulte Estado del disco de EVS. |
attachments |
Array of VolumeAttachment objects |
La información de conexión. |
availability_zone |
String |
La AZ a la que pertenece el disco. |
bootable |
String |
Si el disco es arrancable. true: el disco es arrancable. false: el disco no se puede arrancar. |
encrypted |
Boolean |
Este campo no se admite actualmente. |
created_at |
String |
La hora en que se creó el disco. Formato de hora: 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, GPSSD2 o ESSD2.
|
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. Este campo no se admite actualmente. |
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 se puede compartir. Nota: Este campo ha sido obsoleto. Use multiattach. |
multiadjunto |
Boolean |
Si el disco se puede compartir. true: el disco se puede compartir. false: el disco no se puede compartir. |
storage_cluster_id |
String |
El campo reservado. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
El enlace de acceso directo correspondiente. |
rel |
String |
El nombre del marcador de enlace de acceso directo. Valor predeterminado: next |
Parámetro |
Tipo |
Descripción |
---|---|---|
attached_at |
String |
La hora a la que se ha conectado el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
attachment_id |
String |
El ID del archivo adjunto. |
device |
String |
El nombre del dispositivo. |
host_name |
String |
Nombre del host físico que alberga el servidor en la nube al que está conectado el disco. |
id |
String |
El ID del disco conectado. |
server_id |
String |
El ID del servidor al que está conectado el disco. |
volume_id |
String |
El ID del disco. |
Parámetro |
Tipo |
Descripción |
---|---|---|
__system__cmkid |
String |
El ID de CMK de encriptación de metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes.
NOTA:
Utilice una solicitud de HTTPS para obtener el ID de clave. Para obtener más detalles, consulte Consulta de la lista de claves. |
__system__encrypted |
String |
El campo de encriptación de metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si este parámetro no aparece, el disco no está cifrado. |
full_clone |
String |
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. |
hw:passthrough |
String |
Si este parámetro se establece en true, el tipo de dispositivo de disco es SCSI, lo que permite que los sistemas operativos de ECS accedan directamente a los medios de almacenamiento subyacentes. Se admiten comandos de reserva SCSI. Si este parámetro se establece en false, el tipo de dispositivo de disco es VBD, que también es el tipo predeterminado. VBD solo admite los comandos simples de lectura/escritura de SCSI. Si este parámetro no está disponible, el tipo de dispositivo de disco es VBD. |
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
POST https://{endpoint}/v3/{project_id}/volumes { "volume" : { "name" : "openapi_vol01", "imageRef" : "027cf713-45a6-45f0-ac1b-0ccc57ac12e2", "availability_zone" : "az-dc-1", "description" : "create for api test", "volume_type" : "SATA", "metadata" : { "volume_owner" : "openapi" }, "multiattach" : false, "size" : 40 }, "OS-SCH-HNT:scheduler_hints" : { "dedicated_storage_id" : "eddc1a3e-4145-45be-98d7-bf6f65af9767" } }
Ejemplo de respuestas
Código de estado: 202
Aceptado
{ "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
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.