文档首页/ 企业主机安全 HSS/ API参考（联盟区域）/ API说明/ 勒索防护/ 查询HSS存储库绑定的备份策略信息
更新时间：2026-01-08 GMT+08:00
查看PDF
分享

查询HSS存储库绑定的备份策略信息

功能介绍

查询HSS存储库绑定的备份策略信息,确保已经购买了勒索防护存储库，可以从cbr云备份服务进行验证，确保已经存在HSS_projectid命名的存储库已经购买

URI

GET /v5/{project_id}/backup/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，查询所有企业项目时填写：all_granted_eps

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

region

是

String

Region ID

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

enabled

Boolean

策略是否启用

id

String

策略ID

name

String

策略名称

operation_type

String

备份类型。备份（backup）、复制(replication)，包含如下2种。

  • backup ：备份。

  • replication ：复制。

operation_definition

OperationDefinitionInfo object

策略属性 保留规则

trigger

BackupTriggerInfo object

备份:策略时间调度规则
表5 OperationDefinitionInfo

参数

参数类型

描述

day_backups

Integer

保留日备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0,最大值：100

max_backups

Integer

单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空，备份会永久保留。最小值：1,最大值：99999,缺省值：-1

month_backups

Integer

保留月备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0, 最大值：100

retention_duration_days

Integer

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

timezone

String

用户所在时区,格式形如UTC+08:00,若没有选择年备，月备，周备，日备中任一参数，则不能选择该参数。

week_backups

Integer

保留周备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。

year_backups

Integer

保留年备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0，最大值：100
表6 BackupTriggerInfo

参数

参数类型

描述

id

String

调度器id

name

String

调度器名称

type

String

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

properties

BackupTriggerPropertiesInfo object

调度器属性
表7 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

请求示例

查询HSS存储库绑定的备份策略信息。

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

响应示例

状态码：200

请求已成功

{
  "enabled" : true,
  "id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "name" : "HSS_84b5266c14ae489fa6549827f032dc62",
  "operation_type" : "backup",
  "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" ]
    }
  }
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 勒索防护