更新时间:2025-11-13 GMT+08:00
分享

恢复集群 - RestoreCluster

功能介绍

该接口用于使用快照恢复集群。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dws:cluster:restoreSnapshot

    Write

    cluster *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    • dws:openAPISnapshot:restore

    -

URI

POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

snapshot_id

String

参数解释

待恢复的快照ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

restore

Restore object

参数解释

恢复对象。

取值范围

不涉及。

表3 Restore

参数

是否必选

参数类型

描述

name

String

参数解释

集群名称。

取值范围

要求唯一性,必须以字母开头并只包含字母、数字、中划线,下划线,长度为4~64个字符。

subnet_id

String

参数解释

指定子网ID,用于集群网络配置。

取值范围

默认值与原集群相同。

security_group_id

String

参数解释

指定安全组ID,用于集群网络配置。默认值与原集群相同。

取值范围

不涉及。

vpc_id

String

参数解释

指定虚拟私有云ID,用于集群网络配置。默认值与原集群相同。

取值范围

不涉及。

availability_zone

String

参数解释

指定集群可用区。默认值与原集群相同。

取值范围

不涉及。

port

Integer

参数解释

指定集群服务端口。

取值范围

不涉及。

public_ip

PublicIp object

参数解释

公网IP地址,如果未指定,则默认不使用公网连接。

取值范围

不涉及。

enterprise_project_id

String

参数解释

企业项目ID,对集群指定企业项目。如果未指定,则使用默认企业项目“default”的ID,即0。

约束限制

不涉及。

取值范围

不涉及。

默认取值

0

ipv6_enable

Boolean

参数解释

指定网络协议类型,表明是否支持IPv6,默认不使用IPv6。

取值范围

不涉及。

number_of_cn

Integer

参数解释

CN部署量。取值范围为3~集群节点数,最大值为20,默认值为3。

取值范围

不涉及。

表4 PublicIp

参数

是否必选

参数类型

描述

public_bind_type

String

参数解释

弹性IP绑定类型。

约束限制

不涉及。

取值范围

auto_assign:自动绑定。

not_use:暂未使用。

bind_existing :使用已有。

默认取值

null

eip_id

String

参数解释

弹性公网IP的id。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

ip_type

String

参数解释

弹性公网IP的类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

eip_address

String

参数解释

弹性公网IP的地址。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

band_width

Integer

参数解释

弹性公网IP的带宽。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

status

String

参数解释

弹性公网IP的状态。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

error_message

String

参数解释

弹性公网IP的错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

cluster

Cluster object

参数解释

集群对象。

取值范围

不涉及。

job_id

String

参数解释

异步任务ID。

取值范围

不涉及。

表6 Cluster

参数

参数类型

描述

id

String

参数解释

集群ID。

取值范围

不涉及。

请求示例

恢复快照到新集群dws-1,新集群在az1.dc1可用区下,数据库端口为8000,带子网ID,安全组ID,虚拟私有云ID,公网IP,企业ID等。

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",
    "number_of_cn" : 3
  }
}

响应示例

状态码:200

恢复集群请求下发成功。

{
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
  },
  "job_id" : "2c9080458942e9c001894430d8ed0abc"
}

SDK代码示例

SDK代码示例如下。

恢复快照到新集群dws-1,新集群在az1.dc1可用区下,数据库端口为8000,带子网ID,安全组ID,虚拟私有云ID,公网IP,企业ID等。

 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
64
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")
            .withNumberOfCn(3);
        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());
        }
    }
}

恢复快照到新集群dws-1,新集群在az1.dc1可用区下,数据库端口为8000,带子网ID,安全组ID,虚拟私有云ID,公网IP,企业ID等。

 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
# 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",
            number_of_cn=3
        )
        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)

恢复快照到新集群dws-1,新集群在az1.dc1可用区下,数据库端口为8000,带子网ID,安全组ID,虚拟私有云ID,公网IP,企业ID等。

 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
64
65
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"
	numberOfCnRestore:= int32(3)
	restorebody := &model.Restore{
		Name: "dws-1",
		SubnetId: &subnetIdRestore,
		SecurityGroupId: &securityGroupIdRestore,
		VpcId: &vpcIdRestore,
		AvailabilityZone: &availabilityZoneRestore,
		Port: &portRestore,
		PublicIp: publicIpRestore,
		EnterpriseProjectId: &enterpriseProjectIdRestore,
		NumberOfCn: &numberOfCnRestore,
	}
	request.Body = &model.RestoreClusterRequestBody{
		Restore: restorebody,
	}
	response, err := client.RestoreCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

恢复集群请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档