文档

DescribeBackupPolicy - 查询服务器防勒索防护策略详情

更新时间:

查询服务器防勒索防护策略详情。

调试

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

授权信息

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

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

请求参数

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

防勒索备份策略 ID。

说明 调用 DescribeBackupPolicies 接口可以获取该参数。
51880

返回参数

名称类型描述示例值
object

策略详情返回数据。

RequestIdstring

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

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
BackupPolicyDetailobject

策略的详细信息。

Statusstring

防勒索防护策略的状态。

  • enabled:策略已手动启用。

  • disabled:策略已手动停用。策略停用后,正在运行的备份任务将停止。

  • closed:防勒索容量超出,系统停用策略。

closed
PolicyVersionstring

防护策略的版本。

  • 1.0.0
  • 2.0.0
2.0.0
Policystring

防勒索防护策略的内容。该参数为 JSON 格式,字段说明如下:

  • 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 磁盘格式的文件备份。
{ "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.*" ], "ExcludeSystemPath": true, "Include": [], "IsDefault": 1, "Retention": 7, "Schedule": "I|1630689360|PT24H", "Source": [], "SpeedLimiter": "", "UseVss": true }
ClientStatusstring

防勒索客户端的状态。取值:

  • running:状态正常

  • exception:状态异常

running
Namestring

策略名称。

testBuckUp
Idlong

防勒索备份策略 ID。

51880
RegionIdstring

备份服务地域 ID。

cn-beijing
UuidListarray

已启用备份策略的服务器的 UUID 列表。

string

已启用备份策略的服务器的 UUID。

inet-49611a6b-a98a-455d-a18a-92af9265****

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "BackupPolicyDetail": {
    "Status": "closed",
    "PolicyVersion": "2.0.0",
    "Policy": "{\n      \"Exclude\": [\n            \"/bin/\",\n            \"/usr/bin/\",\n            \"/sbin/\",\n            \"/boot/\",\n            \"/proc/\",\n            \"/sys/\",\n            \"/srv/\",\n            \"/lib/\",\n            \"/selinux/\",\n            \"/usr/sbin/\",\n            \"/run/\",\n            \"/lib32/\",\n            \"/lib64/\",\n            \"/lost+found/\",\n            \"/var/lib/kubelet/\",\n            \"/var/lib/ntp/proc\",\n            \"/var/lib/container\",\n            \"Windows\\\\\",\n            \"Python27\\\\\",\n            \"Program Files (x86)\\\\\",\n            \"Program Files\\\\\",\n            \"Boot\\\\\",\n            \"$RECYCLE.BIN\",\n            \"System Volume Information\\\\\",\n            \"Users\\\\Administrator\\\\NTUSER.DAT*\",\n            \"ProgramData\\\\\",\n            \"pagefile.sys\",\n            \"Users\\\\Default\\\\NTUSER.DAT*\",\n            \"Users\\\\Administrator\\\\ntuser.*\"\n      ],\n      \"ExcludeSystemPath\": true,\n      \"Include\": [],\n      \"IsDefault\": 1,\n      \"Retention\": 7,\n      \"Schedule\": \"I|1630689360|PT24H\",\n      \"Source\": [],\n      \"SpeedLimiter\": \"\",\n      \"UseVss\": true\n}",
    "ClientStatus": "running",
    "Name": "testBuckUp",
    "Id": 51880,
    "RegionId": "cn-beijing",
    "UuidList": [
      "inet-49611a6b-a98a-455d-a18a-92af9265****"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

  • 本页导读 (1)
文档反馈