查询备份策略列表 - ListBackupPolicy
功能介绍
查询备份策略列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
 - 如果使用身份策略授权,当前API调用无需身份策略权限。
 
URI
GET /v5/{project_id}/ransomware/backup/policies
| 
         参数  | 
       
         是否必选  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         是  | 
       
         String  | 
       
         参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及  | 
      
| 
         参数  | 
       
         是否必选  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|---|
| 
         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位 默认取值: 不涉及  | 
      
请求参数
响应参数
状态码:200
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         total_num  | 
       
         Integer  | 
       
         参数解释 总数 取值范围 取值0-2097152  | 
      
| 
         data_list  | 
       
         Array of GetBackupPolicyResponseInfo objects  | 
       
         参数解释 备份策略列表 取值范围 取值0-10241  | 
      
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         enabled  | 
       
         Boolean  | 
       
         参数解释: 策略是否启用 取值范围:  | 
      
| 
         id  | 
       
         String  | 
       
         参数解释: 策略ID 取值范围: 字符长度1-128  | 
      
| 
         name  | 
       
         String  | 
       
         参数解释: 策略名称 取值范围: 字符长度1-128  | 
      
| 
         operation_type  | 
       
         String  | 
       
         参数解释: 备份类型 取值范围:  | 
      
| 
         operation_definition  | 
       
         OperationDefinitionInfo object  | 
       
         参数解释: 策略属性保留规则 取值范围: 不涉及。  | 
      
| 
         trigger  | 
       
         BackupTriggerInfo object  | 
       
         参数解释: 备份策略时间调度规则 取值范围: 不涉及  | 
      
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         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也必选。 取值范围: ...  | 
      
| 
         year_backups  | 
       
         Integer  | 
       
         参数解释: 保留年备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。 取值范围: 取值为0到100。  | 
      
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         id  | 
       
         String  | 
       
         参数解释: 调度器id 取值范围: 字符长度0-256  | 
      
| 
         name  | 
       
         String  | 
       
         参数解释: 调度器名称 取值范围: 字符长度0-256  | 
      
| 
         type  | 
       
         String  | 
       
         参数解释: 调度器类型,目前只支持time,定时调度。 取值范围: 字符长度0-256  | 
      
| 
         properties  | 
       
         BackupTriggerPropertiesInfo object  | 
       
         调度器属性  | 
      
| 
         参数  | 
       
         参数类型  | 
       
         描述  | 
      
|---|---|---|
| 
         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" : "* 1 1",
        "start_time" : "2020-01-08 09:59:49"
      }
    }
  } ]
}
  状态码
| 
         状态码  | 
       
         描述  | 
      
|---|---|
| 
         200  | 
       
         请求已成功  | 
      
错误码
请参见错误码。