Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Elastic Volume Service/ Referencia de la API/ API/ Gestión de discos/ Consulta de detalles sobre todos los discos de EVS
Actualización más reciente 2026-04-23 GMT+08:00

Consulta de detalles sobre todos los discos de EVS

Función

Esta API se utiliza para consultar detalles sobre todos los discos de EVS.

Método de invocación

Para obtener más información, consulte Invocación de las API.

Información de autorización

Cada cuenta tiene todos los permisos necesarios para invocar todas las API, pero los usuarios de IAM deben tener asignados los permisos requeridos.

  • Si está utilizando la autorización basada en roles/políticas, consulte Políticas de permisos y acciones admitidas para obtener más información sobre los permisos requeridos.
  • Si está utilizando la autorización basada en políticas de identidad, no se requiere ningún permiso basado en políticas de identidad para invocar esta API.

URI

GET /v2/{project_id}/cloudvolumes/detail

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

Definición

El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

marker

No

String

Definición

La consulta de paginación por ID de disco. Los datos de la primera página se consultan de forma predeterminada. Cuando se especifica un ID de disco en marker, se consulta la información de todos los discos que siguen al disco especificado. (La información sobre el disco especificado no se incluye en los resultados de la consulta).

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

name

No

String

Definición

El nombre del disco.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

limit

No

Integer

Definición

Cantidad máxima de resultados de consultas que se pueden devolver.

Restricciones

N/D

Rango

N/D

Valor predeterminado

1000

sort_key

No

String

Definición

La palabra clave en función de la cual se ordenan los resultados devueltos.

Restricciones

N/D

Rango

  • id: El ID del disco.

  • status: El estado del disco. Para obtener el ID del disco, consulte ["Estado del disco de EVS"].

  • created_at: La hora en que se creó el disco.

-size: La capacidad del disco, en GiB.

Valor predeterminado

created_at

offset

No

Integer

Definición

El desplazamiento de la consulta.

Restricciones

Este parámetro se utiliza junto con *limit al consultar los discos de EVS. Supongamos que hay 30 discos. Si establece offset en 11 y limit en 10, la consulta comienza desde el duodécimo disco. Se puede consultar un máximo de 10 discos a la vez.

Rango

N/D

Valor predeterminado

N/D

sort_dir

No

String

Definición

El orden de clasificación del resultado.

Restricciones

N/D

Rango

desc: el orden descendente

asc: el orden ascendente

Valor predeterminado

desc

status

No

String

Definición

El estado del disco. [Para obtener más información, consulte Estado del disco de EVS].

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

metadata

No

String

Definición

Los metadatos del disco.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

availability_zone

No

String

Definición

La información de AZ.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

multiattach

No

Boolean

Definición

Si el disco es compartible.

Restricciones

N/D

Rango

true: El disco es compartible.

false: El disco no es compartible.

Valor predeterminado

N/D

service_type

No

String

Definición

El tipo de servicio.

Restricciones

N/D

Rango

  • EVS

  • DSS

  • DESS

Valor predeterminado

N/D

dedicated_storage_id

No

String

Definición

El ID del grupo de almacenamiento dedicado. Puede utilizar este parámetro para filtrar todos los discos de este grupo de almacenamiento dedicado mediante coincidencia exacta.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

dedicated_storage_name

No

String

Definición

El nombre del grupo de almacenamiento dedicado. Puede utilizar este parámetro para filtrar todos los discos de este grupo de almacenamiento dedicado mediante coincidencia difusa.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

volume_type_id

No

String

Definición

El ID del tipo de disco.

Puede invocar la API Consulta de tipos de disco de EVS y obtener el valor de id de la tabla que describe el campo volume_types.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

id

No

String

Definición

El ID del disco.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

ids

No

String

Definición

Los ID de discos. El valor está en formato ids=['id1','id2',...,'idx']. En la respuesta, el valor ids solo contiene los ID de disco válidos. Los ID de disco no válidos se ignoran.

Restricciones

Puede consultar detalles sobre hasta 60 discos.

Si se especifican tanto id como ids en la solicitud, id se ignorará.

Rango

N/D

Valor predeterminado

N/D

enterprise_project_id

No

String

Definición

El ID del proyecto de empresa, que se utiliza para filtrar.

Si se transfiere all_granted_eps, se consultarán los discos de todos los proyectos empresariales que estén dentro del alcance del permiso.

Para obtener más información sobre los proyectos empresariales y cómo obtener los ID de proyecto empresariales, consulte Guía del usuario de Enterprise Management.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

server_id

No

String

Definición

El ID del servidor.

Puede invocar a la API de ECS Consulta de detalles sobre los ECS para obtener el ID del ECS.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

bootable

No

Boolean

Definición

Si el disco es un disco de arranque o un disco de sistema.

Restricciones

N/D

Rango

El valor true indica un disco de arranque o un disco de sistema, y el valor false indica un disco de datos.

Valor predeterminado

N/D

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Definición

El token de usuario.

Puede obtenerlo invocando la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Restricciones

N/D

Rango

N/D

Valor predeterminado

N/D

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

count

Integer

Definición

El número total de discos consultados. Este valor no se ve afectado por la paginación.

Rango

N/D

volumes_links

Array of Link objects

Definición

El marcador de posición de consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devuelve la URL del último disco consultado. Puede utilizar esta URL para continuar consultando los discos restantes en la siguiente consulta.

Rango

N/D

volumes

Array of VolumeDetail objects

Definición

La lista de discos devueltos.

Rango

N/D

Tabla 5 VolumeDetail

Parámetro

Tipo

Descripción

id

String

Definición

El ID del disco.

Rango

N/D

links

Array of Link objects

Definición

El URI del disco.

Rango

N/D

name

String

Definición

El nombre del disco.

Rango

N/D

status

String

Definición

El estado del disco.

Rango

Para obtener más información, consulte Estado del disco de EVS.

attachments

Array of Attachment objects

Definición

La información de conexión del disco.

Rango

N/D

availability_zone

String

Definición

La AZ a la que pertenece el disco.

Rango

N/D

os-vol-host-attr:host

String

Definición

El campo reservado.

Rango

N/D

source_volid

String

Definición

El ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen.

Actualmente, este campo no se admite.

Rango

N/D

snapshot_id

String

Definición

El ID de instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea.

Rango

N/D

description

String

Definición

La descripción del disco.

Rango

N/D

created_at

String

Definición

La hora en que se creó el disco.

Rango

Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX

os-vol-tenant-attr:tenant_id

String

Definición

El ID del tenant al que pertenece el disco. El ID del tenant es el mismo que el ID del proyecto.

Rango

N/D

volume_image_metadata

Map<String,Object>

Definición

Los metadatos de la imagen del disco.

Para obtener más información sobre el campo volume_image_metadata, consulte Consulta de detalles de imágenes (API nativa de OpenStack).

Rango

N/D

volume_type

String

Definición

El tipo de disco.

Rango

El valor puede ser SATA, SAS, GPSSD, SSD, ESSD o GPSSD2.

  • SATA: el tipo de E/S común (fin de venta)

  • SAS: el tipo de E/S alta

  • GPSSD: el tipo de SSD de uso general

  • SSD: el tipo de E/S ultraalta

  • ESSD: el tipo de SSD extrema

  • GPSSD2: el tipo de SSD V2 de uso general

size

Integer

Definición

La capacidad del disco, en GiB.

Rango

N/D

consistencygroup_id

String

Definición

El campo reservado.

Rango

N/D

bootable

String

Definición

Si el disco es arrancable.

Rango

true: El disco es arrancable.

false: El disco no es arrancable.

metadata

Map<String,Object>

Definición

La información de metadatos del disco. Los usuarios pueden agregar o eliminar la información de metadatos.

Rango

Las claves de este parámetro utilizadas en EVS se describen a continuación:

  • __system__cmkid

    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.

  • __system__encrypted

    El campo de encriptación en metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación).

    Si este parámetro no se especifica, 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.

  • hw:passthrough

    • Si el valor de este parámetro es true, el tipo de dispositivo de disco es SCSI, lo que permite que los SO de ECS accedan directamente al medio de almacenamiento subyacente y admitan comandos de reserva SCSI.

    • Si el valor de este parámetro es false, el tipo de dispositivo de disco es VBD (tipo de dispositivo predeterminado), que solo admite comandos simples de lectura/escritura SCSI.

    • Si no se especifica este parámetro, el tipo de dispositivo de disco es VBD.

  • 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.

Para obtener más información sobre cómo obtener el ID de clave, consulte Consulta de la lista de claves.

updated_at

String

Definición

La hora en que se actualizó el disco.

Rango

Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX

encrypted

Boolean

Definición

Actualmente, este campo no se admite.

Rango

N/D

replication_status

String

Definición

El campo reservado.

Rango

N/D

os-volume-replication:extended_status

String

Definición

El campo reservado.

Rango

N/D

os-vol-mig-status-attr:migstat

String

Definición

El campo reservado.

Rango

N/D

os-vol-mig-status-attr:name_id

String

Definición

El campo reservado.

Rango

N/D

shareable

String

Definición

Si el disco es compartible. El valor puede ser true (se puede compartir) o false (no se puede compartir).

Este campo ha sido obsoleto. Utilice multiattach.

Rango

N/D

user_id

String

Definición

El campo reservado.

Rango

N/D

service_type

String

Definición

El tipo de servicio.

Restricciones

N/D

Rango

  • EVS

  • DSS

  • DESS

Valor predeterminado

N/D

multiattach

Boolean

Definición

Si el disco es compartible.

Rango

N/D

dedicated_storage_id

String

Definición

El ID del grupo de almacenamiento dedicado que aloja el disco.

Rango

N/D

dedicated_storage_name

String

Definición

El nombre del grupo de almacenamiento dedicado que aloja el disco.

Rango

N/D

tags

Map<String,String>

Definición

Las etiquetas del disco.

Este campo tiene valores si el disco tiene etiquetas. O bien, se deja vacío.

Rango

N/D

wwn

String

Definición

El identificador único utilizado al conectar el disco.

Rango

N/D

enterprise_project_id

String

Definición

El ID del proyecto empresarial al que se ha agregado el disco.

Para obtener más información sobre los proyectos empresariales y cómo obtener los ID de proyecto empresarial, consulte Guía del usuario de Enterprise Management.

Rango

N/D

serial_number

String

Definición

El número de serie del disco.

Este campo solo se devuelve para discos de SCSI que no son HyperMetro y se utiliza para el mapeo de discos en la VM.

Rango

N/D

iops

iops object

Definición

La información de IOPS del disco. Este parámetro solo está disponible para discos SSD V2 de uso general.

Rango

N/D

throughput

throughput object

Definición

La información del throughput del disco. Este parámetro solo aparece para discos SSD V2 de uso general.

Rango

N/D

root_resource_type

String

Definición

El tipo de recurso raíz.

Rango

N/D

root_resource_id

String

Definición

El ID del recurso raíz.

Rango

N/D

parent_resource_type

String

Definición

El tipo de recurso principal.

Rango

N/D

parent_resource_id

String

Definición

El ID del recurso principal.

Rango

N/D

snapshot_policy_id

String

Definición

El ID de la política de instantáneas automáticas aplicada al disco.

Rango

N/D

Tabla 7 Attachment

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 disco 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

Tabla 8 iops

Parámetro

Tipo

Descripción

frozened

Boolean

Definición

La etiqueta congelada.

Rango

N/D

id

String

Definición

El ID de las IOPS del disco.

Rango

N/D

total_val

Integer

Definición

Las IOPS.

Rango

N/D

Tabla 9 throughput

Parámetro

Tipo

Descripción

frozened

Boolean

Definición

La etiqueta congelada.

Rango

N/D

id

String

Definición

El ID del throughput.

Rango

N/D

total_val

Integer

Definición

El throughput.

Rango

N/D

Código de estado: 400

Tabla 10 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Error object

Definición

El código de error devuelto si se produce un error. Para obtener más información sobre el código de error, consulte Códigos de error.

Rango

N/D

Tabla 11 Error

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

  • Consulta de detalles de los discos cuyos ID son e92ba908-82f8-4728-b8cc-82f2f56bd461, 40g42920-4243-420f-8bb2-a0bd7660fbd8 y b1fd8dcc-dd67-4edf-b89e-87c3485112ec (los discos se ordenan por tamaño).

    GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?ids=['e92ba908-82f8-4728-b8cc-82f2f56bd461', '40g42920-4243-420f-8bb2-a0bd7660fbd8', 'b1fd8dcc-dd67-4edf-b89e-87c3485112ec']&offset=0&limit=100&sort_key=size&sort_dir=asc
  • Consulta de detalles de todos los discos de datos compartidos de un ECS (El ID del ECS es 3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c. Los resultados devueltos se ordenan en orden ascendente.)

    GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?server_id=3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c&multiattach=true&sort_dir=asc

Ejemplos de respuestas

Código de estado: 200

OK

{
  "count" : 1,
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "bootable" : "false",
    "created_at" : "2016-05-25T02:42:10.856332",
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "self"
    }, {
      "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "bookmark"
    } ],
    "metadata" : { },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA",
    "service_type" : "EVS",
    "wwn" : " 688860300000d136fa16f48f05992360"
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
    "rel" : "next"
  } ]
}

Código de estado: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Código de ejemplo del SDK

El código de ejemplo 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
46
47
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 ListVolumesSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        EvsClient client = EvsClient.newBuilder()
                .withCredential(auth)
                .withRegion(EvsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListVolumesRequest request = new ListVolumesRequest();
        try {
            ListVolumesResponse response = client.listVolumes(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
30
31
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = EvsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EvsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListVolumesRequest()
        response = client.list_volumes(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
36
37
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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := evs.NewEvsClient(
        evs.EvsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListVolumesRequest{}
	response, err := client.ListVolumes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

Más

Para obtener el código de ejemplo de SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en Explorador de API. El código de ejemplo del SDK se puede generar automáticamente.

Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

Códigos de error

Consulte Códigos de error.