Criação de um snapshot do EVS
Função
Esta API é usada para criar um snapshot do EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
POST /v2/{project_id}/cloudsnapshots
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
O ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
O token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
snapshot |
Sim |
CreateSnapshotOption object |
As informações do snapshot. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
volume_id |
Sim |
String |
O ID do disco de origem. |
force |
Não |
Boolean |
O sinalizador para a criação forçada do snapshot. O valor padrão é false. Se esse valor de parâmetro for false, os snapshots não poderão ser criados à força quando o status do disco estiver attaching. Se esse valor de parâmetro for true, os snapshots poderão ser criados à força mesmo quando o status do disco estiver attaching. |
metadata |
Não |
Map<String,String> |
Os metadados do snapshot. |
description |
Não |
String |
A descrição do snapshot, que pode conter um máximo de 85 caracteres. Mínimo: 0 Máximo: 255 |
name |
Não |
String |
O nome do snapshot. Você pode inserir até 64 caracteres. Quando um backup de disco é criado, um snapshot também será criado e nomeado com o prefixo autobk_snapshot_. As operações não podem ser executadas em tais snapshots. Portanto, é aconselhável não usar autobk_snapshot_ como o prefixo de nomes de snapshots para evitar qualquer inconveniente. Mínimo: 0 Máximo: 255 |
Parâmetros de resposta
Código de status: 202
Parâmetro |
Tipo |
Descrição |
---|---|---|
snapshot |
SnapshotDetails object |
As informações do snapshot. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
O ID do snapshot. |
status |
String |
O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS. |
name |
String |
O nome do snapshot. |
description |
String |
A descrição do snapshot. |
created_at |
String |
A hora em que o snapshot foi criado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
updated_at |
String |
A hora em que o snapshot foi atualizado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
metadata |
Object |
Os metadados do snapshot. |
volume_id |
String |
O ID do disco de origem do snapshot. |
size |
Integer |
O tamanho do snapshot, em GiB. |
os-extended-snapshot-attributes:project_id |
String |
O campo reservado. |
os-extended-snapshot-attributes:progress |
String |
O campo reservado. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
A mensagem de erro retornada se ocorrer um erro. Para obter detalhes, consulte Parâmetros no campo error. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
O código de erro retornado se ocorrer um erro. Para os códigos de erro e seus significados, consulte Códigos de erro. |
message |
String |
A mensagem de erro retornada se ocorrer um erro. |
Exemplo de solicitações
Criar um snapshot (se o disco EVS de origem estiver anexado, o snapshot não poderá ser criado à força.)
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" } } }
Exemplo de respostas
Código de status: 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 status: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Código de amostra do SDK
O código de amostra do SDK é o seguinte.
Java
Criar um snapshot (se o disco EVS de origem estiver anexado, o snapshot não poderá ser criado à força.)
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 |
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"); ICredential auth = new BasicCredentials() .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
Criar um snapshot (se o disco EVS de origem estiver anexado, o snapshot não poderá ser criado à força.)
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 |
# 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 = 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
Criar um snapshot (se o disco EVS de origem estiver anexado, o snapshot não poderá ser criado à força.)
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 |
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.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) } } |
Mais
Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
202 |
Accepted |
400 |
Bad Request |
Códigos de erro
Consulte Códigos de erro.