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 de 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, 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 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í | CinderCreateVolumeOption object | La información del disco que se va a crear. Nota: No se admite la especificación de dos de los campos source_volid, snapshot_id e imageRef juntos. |
| OS-SCH-HNT:scheduler_hints | No | El parámetro de programación. Se admite el campo dedicated_storage_id, lo que indica que los discos se pueden crear en grupos de almacenamiento de DSS. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| availability_zone | No | 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. Si se transfiere disaster_recovery_azs, este campo se puede dejar en blanco. |
| disaster_recovery_azs | No | Array of strings | Las AZ para crear el disco de DR. Si se transfiere availability_zone, este campo se puede dejar en blanco. |
| consistencygroup_id | No | String | El ID del grupo de consistencia. Si se especifica este parámetro, el disco pertenece a este grupo de consistencia. Esta función no está disponible actualmente. |
| description | No | String | La descripción del disco. Puede ingresar 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 más información sobre cómo obtener el ID de la imagen, consulte 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 clave-valor en metadata no puede ser nulo. |
| multiattach | No | Boolean | Si el disco es compartible. Valor predeterminado: false true: disco compartido false: disco no compartido Para obtener más información, consulte Gestión de discos de EVS compartidos. |
| name | No | String | El nombre del disco. Puede ingresar 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 se 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 se 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. Si se crea el disco a partir de una copia de respaldo, size es opcional. |
| 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 se clona a partir de otro disco. Esta función no está disponible actualmente. |
| source_volid | No | String | El ID del disco de origen. Si se especifica este parámetro, el disco se clona a partir de un disco existente. Esta función no se admite actualmente. |
| volume_type | Sí | String | El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2.
Si el tipo de disco especificado no está disponible en la AZ, el disco no se creará. NOTA: Si crea el disco a partir de una instantánea, el valor de volume_type debe coincidir con el del disco de origen de la instantánea. Para obtener más información sobre los tipos de disco, consulte Tipos de disco y rendimiento. |
| iops | No | Integer | Las IOPS configuradas para el disco. Este parámetro es obligatorio cuando compra discos SSD V2 de uso general. Este parámetro no está disponible para otros tipos de discos de EVS. NOTA:
|
| throughput | No | Integer | El throughput configurado, en la unidad de MiB/s. Este parámetro es obligatorio solo cuando se crea un disco SSD V2 de uso general. NOTA:
|
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| __system__cmkid | No | 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 | No | String | Definición El campo de encriptación en metadata. Si este parámetro no aparece, el disco no está encriptado. Rango
|
| hw:passthrough | No | 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
|
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 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 | Este campo no se admite actualmente. |
| 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. 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 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
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"
}
} Ejemplos de respuestas
Código de estado: 202
Accepted
{
"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 |
|---|---|
| 202 | Accepted |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.