更新时间:2025-06-17 GMT+08:00
分享

设置同区域备份策略

功能介绍

设置同区域备份策略。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

backup_policy

MysqlBackupPolicy object

参数解释

数据库备份策略信息。

约束限制

不涉及。

表4 MysqlBackupPolicy

参数

是否必选

参数类型

描述

start_time

String

参数解释

备份时间段。自动备份将在该时间段内触发。

约束限制

不涉及。

取值范围

非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同,且取值必须为00。

默认取值

不涉及。

keep_days

Integer

参数解释

备份文件的保留天数。

约束限制

不涉及。

取值范围

1~732。您也可以联系客服申请开通最大保留天数为3660。

默认取值

不涉及。

period

String

参数解释

备份周期配置。自动备份将在每星期指定的天进行。

约束限制

格式为逗号隔开的数字,数字加1表示自动备份的星期日期,1,2,3,4,5,6,7表示备份周期配置为星期二、星期三、星期四、星期五、星期六、星期日、星期一。

取值范围

数字1-7可选多个,用逗号隔开。

默认取值

不涉及。

retention_num_backup_level1

Integer

参数解释

一级备份保留数量。

约束限制

当一级备份开关开启时,该参数必传。反之,不能传。

取值范围

0或1。

默认取值

0。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

状态信息。

取值范围

不涉及。

instance_id

String

参数解释

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

取值范围

与请求的实例ID相同。

instance_name

String

参数解释

实例名称。

取值范围

实例ID对应的实例名称。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改实例的自动备份策略,每周的周二至周六的19:00-20:00进行备份,备份文件保留7天。

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/21b6ea5a78244de98c1c2622e1dc593ain07/backups/policy/update

{
  "backup_policy" : {
    "keep_days" : 7,
    "start_time" : "19:00-20:00",
    "period" : "1,2,3,4,5"
  }
}

响应示例

状态码:200

Success.

{
  "status" : "COMPLETED",
  "instance_id" : "21b6ea5a78244de98c1c2622e1dc593ain07",
  "instance_name" : "gauss-mysql"
}

SDK代码示例

SDK代码示例如下。

修改实例的自动备份策略,每周的周二至周六的19:00-20:00进行备份,备份文件保留7天。

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


public class UpdateGaussMySqlBackupPolicySolution {

    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();
        UpdateGaussMySqlBackupPolicyRequest request = new UpdateGaussMySqlBackupPolicyRequest();
        request.withInstanceId("{instance_id}");
        MysqlUpdateBackupPolicyRequest body = new MysqlUpdateBackupPolicyRequest();
        MysqlBackupPolicy backupPolicybody = new MysqlBackupPolicy();
        backupPolicybody.withStartTime("19:00-20:00")
            .withKeepDays(7)
            .withPeriod("1,2,3,4,5");
        body.withBackupPolicy(backupPolicybody);
        request.withBody(body);
        try {
            UpdateGaussMySqlBackupPolicyResponse response = client.updateGaussMySqlBackupPolicy(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());
        }
    }
}

修改实例的自动备份策略,每周的周二至周六的19:00-20:00进行备份,备份文件保留7天。

 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

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 = UpdateGaussMySqlBackupPolicyRequest()
        request.instance_id = "{instance_id}"
        backupPolicybody = MysqlBackupPolicy(
            start_time="19:00-20:00",
            keep_days=7,
            period="1,2,3,4,5"
        )
        request.body = MysqlUpdateBackupPolicyRequest(
            backup_policy=backupPolicybody
        )
        response = client.update_gauss_my_sql_backup_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)

修改实例的自动备份策略,每周的周二至周六的19:00-20:00进行备份,备份文件保留7天。

 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"
    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.UpdateGaussMySqlBackupPolicyRequest{}
	request.InstanceId = "{instance_id}"
	backupPolicybody := &model.MysqlBackupPolicy{
		StartTime: "19:00-20:00",
		KeepDays: int32(7),
		Period: "1,2,3,4,5",
	}
	request.Body = &model.MysqlUpdateBackupPolicyRequest{
		BackupPolicy: backupPolicybody,
	}
	response, err := client.UpdateGaussMySqlBackupPolicy(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.

错误码

请参见错误码

相关文档