文档

CreateBackupPolicy - 创建勒索病毒防护策略

更新时间:

创建服务器勒索病毒防护策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:CreateBackupPolicyWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Namestring

设置要创建的防护策略的名称。

ServerBackUpPolicy01
Policyobject
  • IsDefault:要新建的防护策略的类型。取值:
    • 1:推荐策略
    • 0:自定义策略
  • Include:要防护的文件类型。防护全部文件类型时,该参数设置为[]。
  • Source:要防护的服务器目录。需要防护全部目录时,该参数设置为[]。
  • ExcludeSystemPath:设置是否排除指定目录。要排除该参数设置为 true,不排除则无需设置该参数。
  • Exclude:设置指定的防护目录地址。不设置指定防护目录地址时,该参数设置为[]。
  • Schedule:设置数据备份任务的执行时间和执行间隔。建议指定在业务低峰期非整点。设置示例如下:
    • 例 1:I|1583216092|P21D 表示数据备份开始时间为 2020-03-03 14:14:52,备份策略执行间隔为 3 周。
    • 例 2:I|1583216092|PT24H 表示数据备份开始时间为 2020-03-03 14:14:52,备份策略执行间隔为 24 小时。
  • Retention:设置备份数据保留时间,单位为天。7 表示 1 周,365 表示 1 年,-1 表示永久。
  • SpeedLimiter:设置备份网络带宽限制。例如:0:24:30720 表示 0~24 时备份网络带宽限制为 30 MByte/s。
  • UseVss:是否启用 VSS(Windows)功能。取值:
    • true:启用
    • false:不启用
说明 VSS(Windows)功能仅为 Windows 系统开启,开启后会有效降低因进程占用导致的个别文件备份失败的问题,建议开启。启用该功能后,将不支持 exFAT 和 FAT32 磁盘格式的文件备份。
"{"IsDefault":1,"Include":[],"Source":[],"Schedule":"I|1648061040|PT24H","Retention":7,"SpeedLimiter":"","ExcludeSystemPath":true,"Exclude":["/bin/","/usr/bin/","/sbin/","/boot/","/proc/","/sys/","/srv/","/lib/","/selinux/","/usr/sbin/","/run/","/lib32/","/lib64/","/lost+found/","/var/lib/kubelet/","/var/lib/ntp/proc","/var/lib/container","Windows","Python27","Program Files (x86)","Program Files","Boot","$RECYCLE.BIN","System Volume Information","Users\Administrator\NTUSER.DAT*","ProgramData","pagefile.sys","Users\Default\NTUSER.DAT*","Users\Administrator\ntuser.*"],"UseVss":true}"
PolicyVersionstring

防护策略的版本。固定取值2.0.0

2.0.0
PolicyRegionIdstring

非阿里云服务器所在的地域 ID。

说明 您可以调用 DescribeSupportRegion 接口查看防勒索支持的地域,然后根据您的非阿里云服务器所在的地域就近选择防勒索支持的地域。
ch-hangzhou
UuidListarray

指定需要防护的服务器 UUID 集合。

string

要防护的服务器的 UUID 列表。多个 UUID 之间使用半角逗号(,)隔开。

说明 您可调用 DescribeCloudCenterInstances 接口获取服务器的 UUID。
3bb30859-b3b5-4f28-868f-b0892c98****

返回参数

名称类型描述示例值
object

创建勒索病毒防护策略返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

24A20733-10A0-4AF6-BE6B-E3322413BB68
BackupPolicyobject

防护策略信息。

Idstring

防勒索防护策略编号。

1301575
Statusstring

策略状态。取值:

  • enabled:开启防护。
  • disabled:关闭防护。
说明 创建后默认是开启防护。
enabled

示例

正常返回示例

JSON格式

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "BackupPolicy": {
    "Id": "1301575",
    "Status": "enabled"
  }
}

错误码

HTTP status code错误码错误信息描述
400AgentNotOnlineThe agent not online.客户端不在线不支持操作,请保持客户端在线后再进行操作。
400AntiRansomwareCapacityUseUpanti ransomware capacity use up防勒索容量不足,请前往购买页面进行扩容。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈