文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 查询备份策略列表 - ListBackupPolicy
更新时间:2025-12-26 GMT+08:00
分享

查询备份策略列表 - ListBackupPolicy

功能介绍

查询备份策略列表。

调用方法

请参见如何调用API

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/ransomware/backup/policies

表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)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

policy_id

String

参数解释:

防护策略id

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

总数

取值范围

取值0-2097152

data_list

Array of GetBackupPolicyResponseInfo objects

参数解释

备份策略列表

取值范围

取值0-10241

表5 GetBackupPolicyResponseInfo

参数

参数类型

描述

enabled

Boolean

参数解释:

策略是否启用

取值范围:

  • true:策略已启用

  • false:策略未启用

id

String

参数解释:

策略ID

取值范围:

字符长度1-128

name

String

参数解释:

策略名称

取值范围:

字符长度1-128

operation_type

String

参数解释:

备份类型

取值范围:

  • backup :备份

operation_definition

OperationDefinitionInfo object

参数解释:

策略属性保留规则

取值范围:

不涉及。

trigger

BackupTriggerInfo object

参数解释:

备份策略时间调度规则

取值范围:

不涉及

表6 OperationDefinitionInfo

参数

参数类型

描述

day_backups

Integer

参数解释:

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

取值范围:

取值为0到100。

max_backups

Integer

参数解释:

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

取值范围:

取值为-1或1-99999

month_backups

Integer

参数解释:

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

取值范围:

取值为0到100。

retention_duration_days

Integer

参数解释:

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

取值范围:

最小值:-1,最大值:99999

timezone

String

参数解释:

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

约束限制:

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

取值范围:

字符长度1-256

默认取值:

不涉及

week_backups

Integer

参数解释:

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

取值范围:

  • UTC+05:00

  • UTC+06:00

  • UTC+07:00

...

year_backups

Integer

参数解释:

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

取值范围:

取值为0到100。

表7 BackupTriggerInfo

参数

参数类型

描述

id

String

参数解释:

调度器id

取值范围:

字符长度0-256

name

String

参数解释:

调度器名称

取值范围:

字符长度0-256

type

String

参数解释:

调度器类型,目前只支持time,定时调度。

取值范围:

字符长度0-256

properties

BackupTriggerPropertiesInfo object

调度器属性

表8 BackupTriggerPropertiesInfo

参数

参数类型

描述

pattern

Array of strings

参数解释:

调度器的调度策略

取值范围:

长度限制为10240个字符,参照iCalendar RFC 2445规范,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE四个参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且时间点间隔不能小于一小时,一个备份策略可以同时设置多个备份时间点,一天最多可以设置24个时间点

start_time

String

参数解释:

调度器开始时间,例如:2020-01-08 09:59:49

取值范围:

字符长度0-256

请求示例

查询备份策略列表

GET https://{endpoint}/v5/{project_id}/ransomware/backup/policies?enterprise_project_id=all_granted_ep&host_id=xxxxxx

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "enabled" : true,
    "id" : "id111",
    "operation_definition" : {
      "day_backups" : 10,
      "max_backups" : 100
    },
    "trigger" : {
      "id" : "schdule_id",
      "name" : "schdule",
      "properties" : {
        "pattern" : [ "BYDAY:MO" ],
        "start_time" : "2020-01-08 09:59:49"
      }
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 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
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.*;


public class ListBackupPolicySolution {

    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();
        ListBackupPolicyRequest request = new ListBackupPolicyRequest();
        try {
            ListBackupPolicyResponse response = client.listBackupPolicy(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());
        }
    }
}
 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
# 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 = ListBackupPolicyRequest()
        response = client.list_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)
 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
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.ListBackupPolicyRequest{}
	response, err := client.ListBackupPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档