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 instantánea/ Consulta de detalles sobre instantáneas de EVS
Actualización más reciente 2024-09-04 GMT+08:00

Consulta de detalles sobre instantáneas de EVS

Función

Esta API se utiliza para consultar detalles sobre instantáneas de EVS.

Método de invocación

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

URI

GET /v2/{project_id}/cloudsnapshots/detail

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

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.

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Integer

El desplazamiento. Este parámetro se utiliza cuando las instantáneas se consultan por página y se utiliza junto con el parámetro limit. Por ejemplo, hay un total de 30 instantáneas. Si establece offset en 11 y limit en 10, la consulta comienza en la duodécima instantánea y se puede consultar un máximo de 10 instantáneas a la vez.

limit

No

Integer

El número máximo de resultados de consulta que se pueden devolver. El valor debe ser un entero mayor que 0. El valor predeterminado es 1000.

name

No

String

El nombre de la instantánea. Puede escribir hasta 64 caracteres.

status

No

String

El estado de la instantánea. Para obtener más detalles, consulte Estado de la instantánea de EVS.

volume_id

No

String

El ID del disco de origen de la instantánea.

availability_zone

No

String

La AZ del disco de origen de la instantánea.

id

No

String

El ID de instantánea para filtrar. Se pueden transferir varios ID para su filtrado. El formato es id=id1&id=id2&id=id3.

dedicated_storage_name

No

String

El nombre del grupo de almacenamiento dedicado.

dedicated_storage_id

No

String

El ID del grupo de almacenamiento dedicado.

service_type

No

String

El tipo de servicio. El valor puede ser EVS, DSS o DESS.

enterprise_project_id

No

String

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 de empresa que se encuentren dentro del ámbito del permiso.

NOTA:

Para obtener detalles sobre cómo obtener identificadores y características de proyectos empresariales, consulte la Descripción general.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

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

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

count

Integer

El número total de instantáneas. El parámetro limit no afecta a este valor.

snapshots

Array of SnapshotList objects

La información de la instantánea.

snapshots_links

Array of Link objects

El marcador de posición de la consulta en la lista de instantáneas. Este campo solo se devuelve cuando se especifica limit en la solicitud e indica que solo se devuelven algunas instantáneas en esta consulta.

Tabla 5 SnapshotList

Parámetro

Tipo

Descripción

id

String

El ID de la instantánea.

status

String

El estado de la instantánea.

name

String

El nombre de la instantánea.

description

String

La descripción de la instantánea.

created_at

String

La hora en que se creó la instantánea.

updated_at

String

La hora en que se actualizó la instantánea.

metadata

Map<String,String>

Los metadatos de la instantánea.

volume_id

String

El disco de origen de la instantánea.

size

Integer

El tamaño de la instantánea.

os-extended-snapshot-attributes:project_id

String

El ID del proyecto.

os-extended-snapshot-attributes:progress

String

El progreso de creación de instantáneas.

dedicated_storage_id

String

El ID del grupo de almacenamiento dedicado.

dedicated_storage_name

String

El nombre del grupo de almacenamiento dedicado.

service_type

String

El tipo de servicio.

Código de estado: 400

Tabla 7 Parámetros del cuerpo de respuesta

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.

Tabla 8 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

  • Consulta de detalles de instantáneas (los ID de instantáneas son c311bb8d-17f1-4e99-aaf9-e132c0391a73 y c7691083-15fa-4045-956c-2bcbfe1b9976. La consulta comienza desde el primer registro. El número de registros devueltos no puede ser superior a 100.)

    GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?id=c311bb8d-17f1-4e99-aaf9-e132c0391a73&id=c7691083-15fa-4045-956c-2bcbfe1b9976&offset=0&limit=100
  • Consulta de detalles de todas las instantáneas del disco de EVS cuyo ID sea f8c7cce6-ec47-43ca-9297-b5604668b08f

    GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?volume_id=f8c7cce6-ec47-43ca-9297-b5604668b08f&service_type=EVS

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "count" : 3,
  "snapshots_links" : [ {
    "href" : "https://{endpoint}/v2/20a68d6b7a124ae2b6b8a22046ee5966/cloudsnapshots/detail?limit=1&marker=fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
    "rel" : "next"
  } ],
  "snapshots" : [ {
    "status" : "available",
    "updated_at" : "2018-06-06T10:58:47.349051",
    "volume_id" : "f687bd70-37b3-4f00-a900-0ba1cfaa5196",
    "id" : "fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
    "size" : 1,
    "os-extended-snapshot-attributes:progress" : "100%",
    "name" : "test03",
    "os-extended-snapshot-attributes:project_id" : "20a68d6b7a124ae2b6b8a22046ee5966",
    "service_type" : "EVS",
    "created_at" : "2018-05-30T03:14:44.457975",
    "metadata" : { }
  } ]
}

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
46
47
48
49
50
51
52
53
54
55
56
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 ListSnapshotsSolution {

    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();
        ListSnapshotsRequest request = new ListSnapshotsRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withName("<name>");
        request.withStatus("<status>");
        request.withVolumeId("<volume_id>");
        request.withAvailabilityZone("<availability_zone>");
        request.withId("<id>");
        request.withDedicatedStorageName("<dedicated_storage_name>");
        request.withDedicatedStorageId("<dedicated_storage_id>");
        request.withServiceType("<service_type>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        try {
            ListSnapshotsResponse response = client.listSnapshots(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
32
33
34
35
36
37
38
39
40
# 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 = ListSnapshotsRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.name = "<name>"
        request.status = "<status>"
        request.volume_id = "<volume_id>"
        request.availability_zone = "<availability_zone>"
        request.id = "<id>"
        request.dedicated_storage_name = "<dedicated_storage_name>"
        request.dedicated_storage_id = "<dedicated_storage_id>"
        request.service_type = "<service_type>"
        request.enterprise_project_id = "<enterprise_project_id>"
        response = client.list_snapshots(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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.ListSnapshotsRequest{}
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	volumeIdRequest:= "<volume_id>"
	request.VolumeId = &volumeIdRequest
	availabilityZoneRequest:= "<availability_zone>"
	request.AvailabilityZone = &availabilityZoneRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	dedicatedStorageNameRequest:= "<dedicated_storage_name>"
	request.DedicatedStorageName = &dedicatedStorageNameRequest
	dedicatedStorageIdRequest:= "<dedicated_storage_id>"
	request.DedicatedStorageId = &dedicatedStorageIdRequest
	serviceTypeRequest:= "<service_type>"
	request.ServiceType = &serviceTypeRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ListSnapshots(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

Aceptar

400

Error en la solicitud

Códigos de error

Consulte Códigos de error.