Creating a Snapshot
Function
This API is used to create a snapshot for a specified cluster.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/snapshots
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| snapshot | Yes | Snapshot object | Definition Snapshot object. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Snapshot name. It must be unique and start with a letter. It consists of 4 to 64 characters. Only letters (case-insensitive), digits, hyphens (-), and underscores (_) are allowed. Range N/A |
| cluster_id | Yes | String | Definition ID of the cluster for which you want to create a snapshot. Range N/A |
| description | No | String | Definition Snapshot description. If no value is specified, the description is empty. The value can contain a maximum of 256 characters. The following special characters are not allowed: !<>'=&" Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| snapshot | SnapshotResp object | Definition Snapshot object. Range N/A |
Example Requests
Create a manual snapshot named snapshot-3 for the cluster whose ID is 44b277eb-39be-4921-be31-3d61b43651d7.
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
{
"snapshot" : {
"name" : "snapshot-3",
"cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
"description" : "Snapshot-3 description"
}
} Example Responses
Status code: 200
The snapshot is created.
{
"snapshot" : {
"id" : "2a4d0f86-67cd-408a-8b66-017454fb7793"
}
} SDK Sample Code
The SDK sample code is as follows.
Create a manual snapshot named snapshot-3 for the cluster whose ID is 44b277eb-39be-4921-be31-3d61b43651d7.
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 | 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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; 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); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); CreateSnapshotRequest request = new CreateSnapshotRequest(); CreateSnapshotRequestBody body = new CreateSnapshotRequestBody(); Snapshot snapshotbody = new Snapshot(); snapshotbody.withName("snapshot-3") .withClusterId("44b277eb-39be-4921-be31-3d61b43651d7") .withDescription("Snapshot-3 description"); 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()); } } } |
Create a manual snapshot named snapshot-3 for the cluster whose ID is 44b277eb-39be-4921-be31-3d61b43651d7.
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.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 = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateSnapshotRequest() snapshotbody = Snapshot( name="snapshot-3", cluster_id="44b277eb-39be-4921-be31-3d61b43651d7", description="Snapshot-3 description" ) 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) |
Create a manual snapshot named snapshot-3 for the cluster whose ID is 44b277eb-39be-4921-be31-3d61b43651d7.
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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 := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateSnapshotRequest{} descriptionSnapshot:= "Snapshot-3 description" snapshotbody := &model.Snapshot{ Name: "snapshot-3", ClusterId: "44b277eb-39be-4921-be31-3d61b43651d7", Description: &descriptionSnapshot, } request.Body = &model.CreateSnapshotRequestBody{ Snapshot: snapshotbody, } response, err := client.CreateSnapshot(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | The snapshot is created. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot