Consulta de detalles sobre un disco de EVS
Función
Esta API se utiliza para consultar detalles sobre un singular disco de EVS. Se admite la autorización de proyectos empresariales.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v2/{project_id}/cloudvolumes/{volume_id}
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. |
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 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ámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
volume |
VolumeDetail object |
Los detalles del disco. |
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 Attachment objects |
La información de conexión de disco. |
availability_zone |
String |
La AZ a la que pertenece el disco. |
os-vol-host-attr:host |
String |
El campo reservado. |
source_volid |
String |
El ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Este campo no se admite actualmente. |
snapshot_id |
String |
El ID de la instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea. |
description |
String |
La descripción del disco. |
created_at |
String |
La hora en que se creó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
os-vol-tenant-attr:tenant_id |
String |
El ID del tenant al que pertenece el disco. El ID del tenant es el mismo que el ID del proyecto. |
volume_image_metadata |
Map<String,Object> |
Los metadatos de la imagen de disco.
NOTA:
Para obtener más detalles sobre el campo volume_image_metadata, véase Consulta de detalles de imagen (API nativa de OpenStack). |
volume_type |
String |
El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2.
|
size |
Integer |
El tamaño del disco, en GiB. |
consistencygroup_id |
String |
El campo reservado. |
bootable |
String |
Si el disco es arrancable. true: el disco es arrancable. false: el disco no se puede arrancar. |
metadata |
Map<String,Object> |
Los metadatos del disco. __system__cmkid: El ID de CMK de encriptación de metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud del ID de CMK se fija en 36 bytes. Para obtener detalles sobre cómo obtener el ID de clave, véase Consulta de la lista de claves. __system__encrypted El campo de encriptación de metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si no se especifica este parámetro, el atributo de encriptación del disco es el mismo que el del origen de datos. Si el disco no se crea a partir de un origen de datos, el disco no se cifra de forma predeterminada. full_clone El método de creación cuando el disco se crea a partir de una instantánea.
hw:passthrough
orderID El parámetro que describe el modo de facturación de disco de metadata. Si este parámetro tiene un valor, el disco se factura anualmente/mensualmente. Si no se especifica este parámetro, el disco se factura en función del pago por uso. |
updated_at |
String |
La hora en que se actualizó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
encrypted |
Boolean |
Este campo no se admite actualmente. |
replication_status |
String |
El campo reservado. |
os-volume-replication:extended_status |
String |
El campo reservado. |
os-vol-mig-status-attr:migstat |
String |
El campo reservado. |
os-vol-mig-status-attr:name_id |
String |
El campo reservado. |
shareable |
String |
Si el disco se puede compartir. El valor puede ser true (se puede compartir) o false (no se puede compartir). Este campo ha sido obsoleto. Use multiattach. |
user_id |
String |
El campo reservado. |
service_type |
String |
El tipo de servicio. EVS, DSS y DESS son servicios soportados. |
multiattach |
Boolean |
Si el disco se puede compartir. |
dedicated_storage_id |
String |
El ID del grupo de almacenamiento dedicado que aloja el disco. |
dedicated_storage_name |
String |
El nombre del grupo de almacenamiento dedicado que aloja el disco. |
tags |
Map<String,String> |
Las etiquetas de disco. Este campo tiene valores si el disco tiene etiquetas. O, se deja vacío. |
wwn |
String |
El identificador único utilizado al conectar el disco. |
enterprise_project_id |
String |
El ID del proyecto de empresa al que se ha agregado el disco. Para obtener detalles sobre cómo obtener identificadores y características de proyectos empresariales, consulte la Descripción general. |
serial_number |
String |
El número de serie del disco. Este campo se devuelve solo para los discos de SCSI que no sean HyperMetro y se utiliza para el mapeo de discos en la VM. |
iops |
iops object |
La información de IOPS del disco. Este parámetro solo aparece para un disco de SSD V2 de uso general o un disco de SSD V2 extremo. |
throughput |
throughput object |
La información del throughput del disco. Este parámetro aparece solo para un disco de SSD V2 de uso general. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
El enlace de acceso directo correspondiente. |
rel |
String |
El nombre del marcador de enlace de acceso directo. |
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 |
El 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 |
---|---|---|
frozened |
Boolean |
La etiqueta congelada. Predeterminado: false |
id |
String |
El ID del IOPS del disco. |
total_val |
Integer |
Las IOPS. |
Parámetro |
Tipo |
Descripción |
---|---|---|
frozened |
Boolean |
La etiqueta congelada. Predeterminado: false |
id |
String |
El ID del throughput. |
total_val |
Integer |
El throughput. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
El mensaje de error devuelto si se produce un error. Para obtener más detalles, consulte Parámetros en el campo error. |
Parámetro |
Tipo |
Descripción |
---|---|---|
code |
String |
El código de error devuelto si se produce un error. Para conocer los códigos de error y sus significados, véase Códigos de error. |
message |
String |
El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
GET https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}
Ejemplo de respuestas
Código de estado: 200
Se devuelve la información del disco.
{ "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "bookmark" } ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "az-dc-1#SSD", "multiattach" : true, "updated_at" : "2016-02-03T02:19:29.895237", "replication_status" : "disabled", "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "metadata" : { }, "tags" : { "key1" : "value1", "key2" : "value2" }, "status" : "available", "description" : "auto-created_from_restore_from_backup", "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } }
Código de estado: 400
Error en la solicitud
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Ejemplo de código del SDK
El ejemplo de código del SDK es el siguiente.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class ShowVolumeSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); ShowVolumeRequest request = new ShowVolumeRequest(); try { ShowVolumeResponse response = client.showVolume(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowVolumeRequest() response = client.show_volume(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowVolumeRequest{} response, err := client.ShowVolume(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Otro más
Para obtener un ejemplo de código del SDK de más lenguajes de programación, consulta la ficha Ejemplo de código en API Explorer. El ejemplo de código del SDK se puede generar automáticamente.
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Se devuelve la información del disco. |
400 |
Error en la solicitud |
Códigos de error
Consulte Códigos de error.