文档首页/ 云备份 CBR/ API参考/ API/ 还原点/ 复制备份还原点
更新时间:2024-06-20 GMT+08:00
分享

复制备份还原点

功能介绍

执行复制

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/checkpoints/replicate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

replicate

CheckpointReplicateParam object

执行复制请求体参数

表4 CheckpointReplicateParam

参数

是否必选

参数类型

描述

auto_trigger

Boolean

本次复制是否自动触发,默认为false,代表手动触发

destination_project_id

String

复制的目标项目ID

destination_region

String

复制的目标区域id

最小长度:0

最大长度:255

destination_vault_id

String

目标区域存储库ID

enable_acceleration

Boolean

跨区域复制时,是否启用加速从而缩短复制的时间,如果不指定,默认不启用加速,如果启用加速,会额外收取加速的费用。

vault_id

String

存储库ID: uuid

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

replication

CheckpointReplicateRespBody object

复制备份还原点响应对象。

表6 CheckpointReplicateRespBody

参数

参数类型

描述

backups

Array of CheckpointReplicateRespbackups objects

待复制的备份列表

destination_project_id

String

复制的目标项目ID

destination_region

String

复制的目标区域

destination_vault_id

String

目标区域存储库ID

project_id

String

执行复制的项目ID

provider_id

String

备份提供商ID

source_region

String

复制的源区域

vault_id

String

存储库ID

表7 CheckpointReplicateRespbackups

参数

参数类型

描述

backup_id

String

待复制的备份ID

replication_record_id

String

复制记录ID

请求示例

手动跨区域复制一个备份副本从源区域到目标区域。

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints/replicate

{
  "replicate" : {
    "auto_trigger" : false,
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "destination_region" : "region2",
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "enable_acceleration" : false,
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
  }
}

响应示例

状态码: 200

OK

{
  "replication" : {
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "source_region" : "region1",
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
    "destination_region" : "region2",
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "backups" : [ {
      "replication_record_id" : "de128dfa-5451-4905-9c11-8fc842b2f41e",
      "backup_id" : "7558e1a3-7046-4787-95cd-14b0ad0642a8"
    }, {
      "replication_record_id" : "892a7d1e-17c8-4751-ad75-cfbed7051857",
      "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d"
    }, {
      "replication_record_id" : "8bf5ce8f-bfa1-4d57-98de-d6159ab9d86d",
      "backup_id" : "aa00034d-ef40-443d-ab7a-dc846d988cdf"
    } ],
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987"
  }
}

SDK代码示例

SDK代码示例如下。

Java

手动跨区域复制一个备份副本从源区域到目标区域。

 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
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.cbr.v1.region.CbrRegion;
import com.huaweicloud.sdk.cbr.v1.*;
import com.huaweicloud.sdk.cbr.v1.model.*;


public class CopyCheckpointSolution {

    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);

        CbrClient client = CbrClient.newBuilder()
                .withCredential(auth)
                .withRegion(CbrRegion.valueOf("<YOUR REGION>"))
                .build();
        CopyCheckpointRequest request = new CopyCheckpointRequest();
        CheckpointReplicateReq body = new CheckpointReplicateReq();
        CheckpointReplicateParam replicatebody = new CheckpointReplicateParam();
        replicatebody.withAutoTrigger(false)
            .withDestinationProjectId("68589cac08274b82b4e254268a3862d8")
            .withDestinationRegion("region2")
            .withDestinationVaultId("0ca3eb86-8800-46da-9c37-9d657a825274")
            .withEnableAcceleration(false)
            .withVaultId("3b5816b5-f29c-4172-9d9a-76c719a659ce");
        body.withReplicate(replicatebody);
        request.withBody(body);
        try {
            CopyCheckpointResponse response = client.copyCheckpoint(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

手动跨区域复制一个备份副本从源区域到目标区域。

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcbr.v1.region.cbr_region import CbrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcbr.v1 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 = CbrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CbrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CopyCheckpointRequest()
        replicatebody = CheckpointReplicateParam(
            auto_trigger=False,
            destination_project_id="68589cac08274b82b4e254268a3862d8",
            destination_region="region2",
            destination_vault_id="0ca3eb86-8800-46da-9c37-9d657a825274",
            enable_acceleration=False,
            vault_id="3b5816b5-f29c-4172-9d9a-76c719a659ce"
        )
        request.body = CheckpointReplicateReq(
            replicate=replicatebody
        )
        response = client.copy_checkpoint(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

手动跨区域复制一个备份副本从源区域到目标区域。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cbr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/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 := cbr.NewCbrClient(
        cbr.CbrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CopyCheckpointRequest{}
	autoTriggerReplicate:= false
	enableAccelerationReplicate:= false
	replicatebody := &model.CheckpointReplicateParam{
		AutoTrigger: &autoTriggerReplicate,
		DestinationProjectId: "68589cac08274b82b4e254268a3862d8",
		DestinationRegion: "region2",
		DestinationVaultId: "0ca3eb86-8800-46da-9c37-9d657a825274",
		EnableAcceleration: &enableAccelerationReplicate,
		VaultId: "3b5816b5-f29c-4172-9d9a-76c719a659ce",
	}
	request.Body = &model.CheckpointReplicateReq{
		Replicate: replicatebody,
	}
	response, err := client.CopyCheckpoint(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档