文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 修改存储库绑定的备份策略
更新时间:2025-08-15 GMT+08:00
分享

修改存储库绑定的备份策略

功能介绍

修改存储库绑定的备份策略

调用方法

请参见如何调用API

URI

PUT /v5/{project_id}/backup/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

参数解释:

策略是否启用

约束限制:

不涉及

取值范围:

  • true :策略已启用

  • false:策略未启用

默认取值:

true

policy_id

String

参数解释:

策略ID,若开启防护时开启备份防护,该字段必选。您可以通过2.7 查询HSS存储库绑定的备份策略信息接口获取ID。

约束限制:

不涉及

取值范围:

字符长度1-256

默认取值:

不涉及

operation_definition

OperationDefinitionRequestInfo object

参数解释:

调度参数

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

trigger

BackupTriggerRequestInfo object

策略时间调度规则

表5 OperationDefinitionRequestInfo

参数

是否必选

参数类型

描述

day_backups

Integer

参数解释:

保留日备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

max_backups

Integer

参数解释:

单个备份对象自动备份的最大备份数。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。

约束限制:

不涉及

取值范围:

取值为-1或1-99999

默认取值:

-1

month_backups

Integer

参数解释:

保留月备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

retention_duration_days

Integer

参数解释:

备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups参数同时为空,备份会永久保留。

约束限制:

不涉及

取值范围:

取值范围-1-99999

默认取值:

-1

timezone

String

参数解释:

用户所在时区,格式形如UTC+08:00

约束限制:

若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。

取值范围:

  • UTC+05:00

  • UTC+06:00

  • UTC+07:00

...

默认取值:

不涉及

week_backups

Integer

参数解释:

保留周备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

year_backups

Integer

参数解释:

保留年备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

表6 BackupTriggerRequestInfo

参数

是否必选

参数类型

描述

properties

BackupTriggerPropertiesRequestInfo object

策略执行时间规则

表7 BackupTriggerPropertiesRequestInfo

参数

是否必选

参数类型

描述

pattern

Array of strings

参数解释:

调度规则。若开启勒索防护时开启备份功能,则该字段必选。

约束限制:

限制24条规则。

取值范围:

调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。每天14:00调度,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'。

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。

PUT https://{endpoint}/v5/{project_id}/backup/policy

{
  "enabled" : true,
  "policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "operation_definition" : {
    "day_backups" : 0,
    "max_backups" : -1,
    "month_backups" : 0,
    "retention_duration_days" : 5,
    "timezone" : "UTC+08:00",
    "week_backups" : 0,
    "year_backups" : 0
  },
  "trigger" : {
    "properties" : {
      "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
    }
  }
}

响应示例

SDK代码示例

SDK代码示例如下。

修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。

 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
66
67
68
69
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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateBackupPolicyInfoSolution {

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateBackupPolicyInfoRequest request = new UpdateBackupPolicyInfoRequest();
        UpdateBackupPolicyRequestInfo body = new UpdateBackupPolicyRequestInfo();
        List<String> listPropertiesPattern = new ArrayList<>();
        listPropertiesPattern.add("FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00");
        BackupTriggerPropertiesRequestInfo propertiesTrigger = new BackupTriggerPropertiesRequestInfo();
        propertiesTrigger.withPattern(listPropertiesPattern);
        BackupTriggerRequestInfo triggerbody = new BackupTriggerRequestInfo();
        triggerbody.withProperties(propertiesTrigger);
        OperationDefinitionRequestInfo operationDefinitionbody = new OperationDefinitionRequestInfo();
        operationDefinitionbody.withDayBackups(0)
            .withMaxBackups(-1)
            .withMonthBackups(0)
            .withRetentionDurationDays(5)
            .withTimezone("UTC+08:00")
            .withWeekBackups(0)
            .withYearBackups(0);
        body.withTrigger(triggerbody);
        body.withOperationDefinition(operationDefinitionbody);
        body.withPolicyId("af4d08ad-2b60-4916-a5cf-8d6a23956dda");
        body.withEnabled(true);
        request.withBody(body);
        try {
            UpdateBackupPolicyInfoResponse response = client.updateBackupPolicyInfo(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());
        }
    }
}

修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateBackupPolicyInfoRequest()
        listPatternProperties = [
            "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00"
        ]
        propertiesTrigger = BackupTriggerPropertiesRequestInfo(
            pattern=listPatternProperties
        )
        triggerbody = BackupTriggerRequestInfo(
            properties=propertiesTrigger
        )
        operationDefinitionbody = OperationDefinitionRequestInfo(
            day_backups=0,
            max_backups=-1,
            month_backups=0,
            retention_duration_days=5,
            timezone="UTC+08:00",
            week_backups=0,
            year_backups=0
        )
        request.body = UpdateBackupPolicyRequestInfo(
            trigger=triggerbody,
            operation_definition=operationDefinitionbody,
            policy_id="af4d08ad-2b60-4916-a5cf-8d6a23956dda",
            enabled=True
        )
        response = client.update_backup_policy_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。

 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
66
67
68
69
package main

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

    request := &model.UpdateBackupPolicyInfoRequest{}
	var listPatternProperties = []string{
        "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00",
    }
	propertiesTrigger := &model.BackupTriggerPropertiesRequestInfo{
		Pattern: listPatternProperties,
	}
	triggerbody := &model.BackupTriggerRequestInfo{
		Properties: propertiesTrigger,
	}
	dayBackupsOperationDefinition:= int32(0)
	maxBackupsOperationDefinition:= int32(-1)
	monthBackupsOperationDefinition:= int32(0)
	retentionDurationDaysOperationDefinition:= int32(5)
	timezoneOperationDefinition:= "UTC+08:00"
	weekBackupsOperationDefinition:= int32(0)
	yearBackupsOperationDefinition:= int32(0)
	operationDefinitionbody := &model.OperationDefinitionRequestInfo{
		DayBackups: &dayBackupsOperationDefinition,
		MaxBackups: &maxBackupsOperationDefinition,
		MonthBackups: &monthBackupsOperationDefinition,
		RetentionDurationDays: &retentionDurationDaysOperationDefinition,
		Timezone: &timezoneOperationDefinition,
		WeekBackups: &weekBackupsOperationDefinition,
		YearBackups: &yearBackupsOperationDefinition,
	}
	enabledUpdateBackupPolicyRequestInfo:= true
	request.Body = &model.UpdateBackupPolicyRequestInfo{
		Trigger: triggerbody,
		OperationDefinition: operationDefinitionbody,
		PolicyId: "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
		Enabled: &enabledUpdateBackupPolicyRequestInfo,
	}
	response, err := client.UpdateBackupPolicyInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档