更新时间:2024-12-16 GMT+08:00
分享

设置跨区域备份策略

功能介绍

设置跨区域备份策略。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

实例ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

backup_policy

UpdateBackupOffsitePolicyInfo object

备份策略信息。

表4 UpdateBackupOffsitePolicyInfo

参数

是否必选

参数类型

描述

open_auto_backup

Boolean

是否开启跨区域全量备份。

  • true:开启跨区域全量备份。

  • false:关闭跨区域全量备份。

open_incremental_backup

Boolean

是否开启跨区域增量备份。

  • true:开启跨区域增量备份,当open_auto_backup开启时才可以开启。

  • false:关闭跨区域增量备份。

destination_project_id

String

设置跨区域备份策略的目标project ID。

租户在某一Region下的project ID。

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

destination_region

String

设置跨区域备份策略的目标区域。

keep_days

Integer

指定已生成的备份文件可以保存的天数。

取值范围:1~1825。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

String

结果。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置跨区域备份策略。

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/offsite-policy

{
  "backup_policy" : {
    "open_auto_backup" : true,
    "open_incremental_backup" : false,
    "destination_project_id" : "fd710c89089a448aa2e666ab15817090",
    "destination_region" : "cn-north-7",
    "keep_days" : 1
  }
}

响应示例

状态码: 200

Success.

{
  "result" : "SUCCESS"
}

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
56
57
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.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class UpdateBackupOffsitePolicySolution {

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

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateBackupOffsitePolicyRequest request = new UpdateBackupOffsitePolicyRequest();
        request.withInstanceId("{instance_id}");
        UpdateBackupOffsitePolicyRequestBody body = new UpdateBackupOffsitePolicyRequestBody();
        UpdateBackupOffsitePolicyInfo backupPolicybody = new UpdateBackupOffsitePolicyInfo();
        backupPolicybody.withOpenAutoBackup(true)
            .withOpenIncrementalBackup(false)
            .withDestinationProjectId("fd710c89089a448aa2e666ab15817090")
            .withDestinationRegion("cn-north-7")
            .withKeepDays(1);
        body.withBackupPolicy(backupPolicybody);
        request.withBody(body);
        try {
            UpdateBackupOffsitePolicyResponse response = client.updateBackupOffsitePolicy(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
41
42
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateBackupOffsitePolicyRequest()
        request.instance_id = "{instance_id}"
        backupPolicybody = UpdateBackupOffsitePolicyInfo(
            open_auto_backup=True,
            open_incremental_backup=False,
            destination_project_id="fd710c89089a448aa2e666ab15817090",
            destination_region="cn-north-7",
            keep_days=1
        )
        request.body = UpdateBackupOffsitePolicyRequestBody(
            backup_policy=backupPolicybody
        )
        response = client.update_backup_offsite_policy(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"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateBackupOffsitePolicyRequest{}
	request.InstanceId = "{instance_id}"
	backupPolicybody := &model.UpdateBackupOffsitePolicyInfo{
		OpenAutoBackup: true,
		OpenIncrementalBackup: false,
		DestinationProjectId: "fd710c89089a448aa2e666ab15817090",
		DestinationRegion: "cn-north-7",
		KeepDays: int32(1),
	}
	request.Body = &model.UpdateBackupOffsitePolicyRequestBody{
		BackupPolicy: backupPolicybody,
	}
	response, err := client.UpdateBackupOffsitePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档