Creación de una instantánea de EVS
Función
Esta API se utiliza para crear una instantánea 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
POST /v2/{project_id}/cloudsnapshots
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | 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 |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Definición El token del 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ámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| snapshot | Sí | CreateSnapshotOption object | Definición La información de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| volume_id | Sí | String | Definición El ID del disco de origen. Puede invocar la API Consulta de detalles sobre todos los discos de EVS para obtener el ID del disco. Restricciones N/D Rango N/D Valor predeterminado N/D |
| force | No | Boolean | Definición Si se debe forzar la creación de instantáneas. Restricciones Si el valor de este parámetro es false, no se crean instantáneas cuando el estado del disco es attaching. Si el valor de este parámetro es true, se pueden crear instantáneas incluso cuando el estado del disco es attaching. Rango false o true Valor predeterminado false |
| metadata | No | Map<String,String> | Definición Los metadatos de la instantánea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| description | No | String | Definición Descripción de la instantánea. Restricciones N/D Rango Puede contener un máximo de 85 caracteres. Valor predeterminado N/D |
| name | No | String | Definición El nombre de la instantánea. Cuando se crea una copia de respaldo para un disco, también se crea una instantánea y se le asigna un nombre con el prefijo autobk_snapshot_. No se pueden realizar operaciones en dichas instantáneas. Se recomienda no utilizar autobk_snapshot_ como prefijo de los nombres de las instantáneas para evitar cualquier inconveniente. Restricciones N/D Rango Puede contener un máximo de 64 caracteres. Valor predeterminado N/D |
Parámetros de respuesta
Código de estado: 202
| Parámetro | Tipo | Descripción |
|---|---|---|
| snapshot | SnapshotDetails object | Definición La información de la instantánea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID de la instantánea. Rango N/D |
| status | String | Definición El estado de la instantánea. Rango Para obtener más información, consulte Estado de la instantánea de EVS. |
| name | String | Definición El nombre de la instantánea. Rango N/D |
| description | String | Definición Descripción de la instantánea. Rango N/D |
| created_at | String | Definición Hora en que se creó la instantánea. Rango Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| updated_at | String | Definición Hora en que se actualizó la instantánea. Rango Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| metadata | Object | Definición Los metadatos de la instantánea. Rango N/D |
| volume_id | String | Definición El ID del disco de origen de la instantánea. Rango N/D |
| size | Integer | Definición Tamaño de la instantánea, en GiB. Rango N/D |
| os-extended-snapshot-attributes:project_id | String | Definición El campo reservado. Rango N/D |
| os-extended-snapshot-attributes:progress | String | Definición El campo reservado. Rango N/D |
Código de estado: 400
| 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 |
| 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 |
Ejemplo de solicitudes
Creación de una instantánea (Si el disco EVS de origen está conectado, no se puede crear la instantánea forzosamente).
POST https://{endpoint}/v2/{project_id}/cloudsnapshots
{
"snapshot" : {
"name" : "snap-001",
"description" : "Daily backup",
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"force" : false,
"metadata" : {
"key_string" : "value_string"
}
}
} Ejemplo de respuestas
Código de estado: 202
Accepted
{
"snapshot" : {
"status" : "creating",
"description" : "Daily backup",
"created_at" : "2013-02-25T03:56:53.081642",
"metadata" : { },
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"size" : 1,
"id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
"name" : "snap-001",
"updated_at" : "2013-02-25T03:56:53.081642"
}
} 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
Creación de una instantánea (Si el disco EVS de origen está conectado, no se puede crear la instantánea forzosamente).
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 58 59 60 | 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.*; import java.util.Map; import java.util.HashMap; public class CreateSnapshotSolution { 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(); CreateSnapshotRequest request = new CreateSnapshotRequest(); CreateSnapshotRequestBody body = new CreateSnapshotRequestBody(); Map<String, String> listSnapshotMetadata = new HashMap<>(); listSnapshotMetadata.put("key_string", "value_string"); CreateSnapshotOption snapshotbody = new CreateSnapshotOption(); snapshotbody.withVolumeId("5aa119a8-d25b-45a7-8d1b-88e127885635") .withForce(false) .withMetadata(listSnapshotMetadata) .withDescription("Daily backup") .withName("snap-001"); body.withSnapshot(snapshotbody); request.withBody(body); try { CreateSnapshotResponse response = client.createSnapshot(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
Creación de una instantánea (Si el disco EVS de origen está conectado, no se puede crear la instantánea forzosamente).
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 | # 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 = CreateSnapshotRequest() listMetadataSnapshot = { "key_string": "value_string" } snapshotbody = CreateSnapshotOption( volume_id="5aa119a8-d25b-45a7-8d1b-88e127885635", force=False, metadata=listMetadataSnapshot, description="Daily backup", name="snap-001" ) request.body = CreateSnapshotRequestBody( snapshot=snapshotbody ) response = client.create_snapshot(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
Creación de una instantánea (Si el disco EVS de origen está conectado, no se puede crear la instantánea forzosamente).
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 | 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.CreateSnapshotRequest{} var listMetadataSnapshot = map[string]string{ "key_string": "value_string", } forceSnapshot:= false descriptionSnapshot:= "Daily backup" nameSnapshot:= "snap-001" snapshotbody := &model.CreateSnapshotOption{ VolumeId: "5aa119a8-d25b-45a7-8d1b-88e127885635", Force: &forceSnapshot, Metadata: listMetadataSnapshot, Description: &descriptionSnapshot, Name: &nameSnapshot, } request.Body = &model.CreateSnapshotRequestBody{ Snapshot: snapshotbody, } response, err := client.CreateSnapshot(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Más
Para obtener el código de ejemplo del 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 |
|---|---|
| 202 | Accepted |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.