全部產品
Search

搜尋本產品

    Security Center：DescribeBackupPolicies

    文件中心

    Security Center：DescribeBackupPolicies

    更新時間：Jun 15, 2026

    查詢防勒索防護策略。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-sas:DescribeBackupPolicies

    list

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Name

    string

    否

    要查詢的防勒索防護策略的名稱。

    SecurityStrategy-20200303
    MachineRemark

    string

    否

    要查詢的防勒索策略防護的伺服器的識別資訊。可輸入伺服器的 IP 地址或例項 ID。

    1.1.XX.XX
    Status

    string

    否

    防勒索防護策略的狀態。

    • enabled：策略已手動啟用。

    • disabled：策略已手動停用。策略停用後，正在執行的備份任務將停止。

    • closed：防勒索容量超出，系統停用策略。

    enabled
    PageSize

    integer

    是

    設定分頁查詢時，每頁包含的備份策略的數量。預設值為 10，表示每頁包含 10 個防護策略。

    10
    CurrentPage

    integer

    是

    設定從返回結果的第幾頁開始顯示。預設值為 1，表示從第 1 頁開始顯示。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    本次呼叫請求的 ID，是由阿里雲為該請求生成的唯一識別符號，可用於排查和定位問題。

    BE120DAB-F4E7-4C53-ADC3-A97578ABF384
    PageInfo

    object

    分頁資訊。

    CurrentPage

    integer

    返回資料當前頁的頁碼。

    1
    PageSize

    integer

    分頁查詢時，每頁包含的備份策略的數量。預設值為 10，表示每頁包含 10 個備份策略。

    10
    TotalCount

    integer

    返回資料中備份策略的總數量。

    30
    Count

    integer

    分頁查詢時，當前頁顯示的資料條數。

    3
    Policies

    array<object>

    防護策略的詳情。

    object

    ClientErrorCount

    integer

    防勒索客戶端的報錯數量。

    2
    Status

    string

    防勒索防護策略的狀態。

    • enabled：策略已手動啟用。

    • disabled：策略已手動停用。策略停用後，正在執行的備份任務將停止。

    • closed：防勒索容量超出，系統停用策略。

    enabled
    PolicyVersion

    string

    防護策略的版本。取值：

    • 1.0.0。

    • 2.0.0。

    2.0.0
    Policy

    string

    防勒索防護策略的內容。該引數為 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}
    UpgradeStatus

    string

    策略的升級狀態。取值：

    • NotUpgraded：未升級

    • Upgrading：升級中

    • UpgradeFailed：升級失敗

    • UpgradeSuccess：升級成功

    Upgrading
    ServiceErrorCount

    integer

    資料備份異常的伺服器的數量。

    2
    PolicyRegionId

    string

    非阿里雲伺服器中安裝防勒索客戶端時選擇的備份服務地域 ID。

    ch-hangzhou
    ClientStatus

    string

    防勒索客戶端的狀態。取值：

    • running：狀態正常

    • exception：狀態異常

    running
    Name

    string

    防勒索防護策略的名稱。

    SecurityStrategy-20200303
    HealthClientCount

    integer

    狀態為“正常”的客戶端的數量。

    2
    Id

    integer

    防勒索防護策略的 ID。

    11
    ClientErrorUuidList

    array

    客戶端狀態異常UUID 列表。

    string

    客戶端狀態異常UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    RemarkedUuidList

    array

    請求引數 MachineRemark 檢索後返回的伺服器的 UUID 列表。

    string

    請求引數 MachineRemark 檢索後返回的伺服器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    UuidList

    array

    防勒索防護策略防護的伺服器的 UUID 列表。

    string

    防勒索防護策略防護的伺服器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    ServiceErrorUuidList

    array

    資料備份異常的伺服器的 UUID 列表。

    string

    資料備份異常的伺服器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    HealthClientUuidList

    array

    狀態為健康的客戶端的 UUID 列表。

    string

    狀態為健康的客戶端的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    ServerType

    string

    伺服器型別。取值：

    • OUT_CLOUD：非阿里雲伺服器

    • ALIYUN：阿里雲伺服器

    • TRIPARTITE：輕量級應用伺服器

    OUT_CLOUD
    LastStatusSyncTime

    integer

    防勒索防護策略狀態最新更新時間，單位毫秒。

    1719488535027
    PreStatus

    string

    防勒索防護策略的上一次狀態。

    • enabled：策略已手動啟用。

    • disabled：策略已手動停用。策略停用後，正在執行的備份任務將停止。

    • closed：防勒索容量超出，系統停用策略。

    disabled

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 30,
    "Count": 3
  },
  "Policies": [
    {
      "ClientErrorCount": 2,
      "Status": "enabled",
      "PolicyVersion": "2.0.0",
      "Policy": "{\"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}",
      "UpgradeStatus": "Upgrading",
      "ServiceErrorCount": 2,
      "PolicyRegionId": "ch-hangzhou",
      "ClientStatus": "running",
      "Name": "SecurityStrategy-20200303",
      "HealthClientCount": 2,
      "Id": 11,
      "ClientErrorUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "RemarkedUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "UuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "ServiceErrorUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "HealthClientUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "ServerType": "OUT_CLOUD",
      "LastStatusSyncTime": 1719488535027,
      "PreStatus": "disabled"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    500 ServerError ServerError
    403 NoPermission caller has no permission

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。