Restoring a Cluster
Function
This API is used to restore a cluster using a snapshot.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
| 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 |
| snapshot_id | Yes | String | Definition ID of the snapshot to be restored. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| restore | Yes | Restore object | Definition Objects of cluster restoration. Range N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Cluster name. Range The value must be unique. It must contain 4 to 64 characters and start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
| subnet_id | No | String | Definition Subnet ID, which is used for configuring the cluster network. Range The default value is the same as that of the original cluster. |
| security_group_id | No | String | Definition Security group ID, which is used for configuring the cluster network. The default value is the same as that of the original cluster. Range N/A |
| vpc_id | No | String | Definition VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster. Range N/A |
| availability_zone | No | String | Definition AZ of the cluster. The default value is the same as that of the original cluster. Range N/A |
| port | No | Integer | Definition Cluster service port. Range N/A |
| public_ip | No | PublicIp object | Definition Public IP address. If the parameter is not specified, public connection is not used by default. Range N/A |
| enterprise_project_id | No | String | Definition Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used. Constraints N/A Range N/A Default Value 0 |
| ipv6_enable | No | Boolean | Definition Network protocol type. It indicates whether IPv6 is supported. By default, IPv6 is not used. Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| cluster | Cluster object | Definition Cluster object. Range N/A |
Example Requests
Restore the snapshot to the new cluster dws-1. (AZ: az1.dc1. Database port: 8000. The subnet ID, security group ID, VPC ID, public IP address, and enterprise ID are specified)
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
{
"restore" : {
"name" : "dws-1",
"subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
"security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
"vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
"availability_zone" : "az1.dc1",
"port" : 8000,
"public_ip" : {
"public_bind_type" : "auto_assign",
"eip_id" : ""
},
"enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
}
} Example Responses
Status code: 200
The request for restoring a cluster is submitted.
{
"cluster" : {
"id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
}
} SDK Sample Code
The SDK sample code is as follows.
Restore the snapshot to the new cluster dws-1. (AZ: az1.dc1. Database port: 8000. The subnet ID, security group ID, VPC ID, public IP address, and enterprise ID are specified)
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 61 62 63 | 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 RestoreClusterSolution { 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(); RestoreClusterRequest request = new RestoreClusterRequest(); request.withSnapshotId("{snapshot_id}"); RestoreClusterRequestBody body = new RestoreClusterRequestBody(); PublicIp publicIpRestore = new PublicIp(); publicIpRestore.withPublicBindType("auto_assign") .withEipId(""); Restore restorebody = new Restore(); restorebody.withName("dws-1") .withSubnetId("374eca02-cfc4-4de7-8ab5-dbebf7d9a720") .withSecurityGroupId("dc3ec145-9029-4b39-b5a3-ace5a01f772b") .withVpcId("85b20d7e-9eb7-4b2a-98f3-3c8843ea3574") .withAvailabilityZone("az1.dc1") .withPort(8000) .withPublicIp(publicIpRestore) .withEnterpriseProjectId("aca4e50a-266f-4786-827c-f8d6cc3fbada"); body.withRestore(restorebody); request.withBody(body); try { RestoreClusterResponse response = client.restoreCluster(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()); } } } |
Restore the snapshot to the new cluster dws-1. (AZ: az1.dc1. Database port: 8000. The subnet ID, security group ID, VPC ID, public IP address, and enterprise ID are specified)
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 | # 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 = RestoreClusterRequest() request.snapshot_id = "{snapshot_id}" publicIpRestore = PublicIp( public_bind_type="auto_assign", eip_id="" ) restorebody = Restore( name="dws-1", subnet_id="374eca02-cfc4-4de7-8ab5-dbebf7d9a720", security_group_id="dc3ec145-9029-4b39-b5a3-ace5a01f772b", vpc_id="85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", availability_zone="az1.dc1", port=8000, public_ip=publicIpRestore, enterprise_project_id="aca4e50a-266f-4786-827c-f8d6cc3fbada" ) request.body = RestoreClusterRequestBody( restore=restorebody ) response = client.restore_cluster(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Restore the snapshot to the new cluster dws-1. (AZ: az1.dc1. Database port: 8000. The subnet ID, security group ID, VPC ID, public IP address, and enterprise ID are specified)
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 61 62 63 | 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.RestoreClusterRequest{} request.SnapshotId = "{snapshot_id}" publicBindTypePublicIp:= "auto_assign" eipIdPublicIp:= "" publicIpRestore := &model.PublicIp{ PublicBindType: &publicBindTypePublicIp, EipId: &eipIdPublicIp, } subnetIdRestore:= "374eca02-cfc4-4de7-8ab5-dbebf7d9a720" securityGroupIdRestore:= "dc3ec145-9029-4b39-b5a3-ace5a01f772b" vpcIdRestore:= "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574" availabilityZoneRestore:= "az1.dc1" portRestore:= int32(8000) enterpriseProjectIdRestore:= "aca4e50a-266f-4786-827c-f8d6cc3fbada" restorebody := &model.Restore{ Name: "dws-1", SubnetId: &subnetIdRestore, SecurityGroupId: &securityGroupIdRestore, VpcId: &vpcIdRestore, AvailabilityZone: &availabilityZoneRestore, Port: &portRestore, PublicIp: publicIpRestore, EnterpriseProjectId: &enterpriseProjectIdRestore, } request.Body = &model.RestoreClusterRequestBody{ Restore: restorebody, } response, err := client.RestoreCluster(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 request for restoring a cluster is submitted. |
| 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