全部產品
Search

搜尋本產品

    Cloud Backup：DescribePolicyBindings - 查詢繫結策略列表

    文件中心

    Cloud Backup：DescribePolicyBindings - 查詢繫結策略列表

    更新時間：Apr 21, 2026

    查詢策略綁定的一個或多個資料來源、查詢資料來源綁定的一個或多個策略。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hbr:DescribePolicyBindings

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    NextToken

    string

    否

    擷取下一頁策略與資料來源關聯所需的 Token。

    caeba0bbb2be03f84eb48b699f0a
    MaxResults

    integer

    否

    每次查詢結果的個數。

    取值範圍：10~100。預設值：10。

    10
    PolicyId

    string

    否

    策略 ID。

    po-000************hky
    DataSourceIds

    array

    否

    資料來源 ID 列表。

    string

    否

    資料來源 ID。

    i-uf6************68n
    SourceType

    string

    否

    資料來源類型。取值範圍：

    • UDM_ECS：表示 ECS 整機備份。

    UDM_ECS
    Filters

    array<object>

    否

    查詢過濾器。

    object

    否

    查詢過濾器。

    Key

    string

    否

    查詢過濾器中的索引值。取值包括：

    • PolicyId：備份策略 ID

    • DataSourceId：ECS 執行個體 ID

    • DataSourceType：資料來源類型

    DataSourceType
    Operator

    string

    否

    匹配方式。預設為 IN。即過濾器中 Key 和 Value 支援的匹配操作（Operator）方式，取值包括：

    • EQUAL：等於

    • NOT_EQUAL：不等於

    • GREATER_THAN：大於

    • GREATER_THAN_OR_EQUAL：大於等於

    • LESS_THAN：小於

    • LESS_THAN_OR_EQUAL：小於等於

    • BETWEEN：區間，value 為 JSON 數組[下屆,上屆]。

    • IN：在集合中，value 為數組。

    IN
    Values

    array

    否

    查詢過濾器中的待匹配的值。

    string

    否

    查詢過濾器中的待匹配的值。

    UDM_ECS

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    DescribePolicyBindingsResponse

    PolicyBindings

    array<object>

    繫結原則列表。

    array<object>

    繫結原則詳情。

    CreatedTime

    integer

    建立時間。UNIX 時間，單位秒。

    1661399570
    UpdatedTime

    integer

    更新時間。UNIX 時間，單位為秒。

    1653611573
    PolicyBindingId

    string

    繫結原則 ID。

    pd-000************slc
    PolicyBindingDescription

    string

    繫結原則描述。

    po-000************eslc-i-uf6************y5g
    PolicyId

    string

    策略 ID。

    po-000************56y
    DataSourceId

    string

    資料來源 ID。

    i-8vb************5ly
    Disabled

    boolean

    策略是否對該資料來源生效。

    • true：暫停

    • false：未暫停

    true
    Source

    string

    • 當 SourceType 取值為 OSS 時，表示備份某個 prefix，如果不指定，則表示備份整個 Bucket 根目錄。

    • 當 SourceType 取值為ECS_FILE或 File 時，表示備份的檔案目錄，如果不指定，則表示備份全部目錄。

    backup/
    Include

    string

    僅當 SourceType 取值為ECS_FILE或 File 時，需要配置該參數。表示要進行備份的檔案類型，這些類型的所有檔案都備份。最多支援 255 個字元。

    [\"*.doc\",\"*.xltm\"]
    Exclude

    string

    僅當 SourceType 取值為ECS_FILE或 File 時，需要配置該參數。表示不需要進行備份的檔案類型，該類型的所有檔案都不備份。最多支援 255 個字元。

    [\"*.doc\",\"*.xltm\"]
    SpeedLimit

    string

    僅當 SourceType 取值為ECS_FILE或 File 時，需要配置該參數。表示備份流量控制。格式為{start}{end}{bandwidth}。多個流量控制配置使用分隔，並且配置時間不允許有重疊。

    • start：起始小時。

    • end：結束小時。

    • bandwidth：限制速率，單位 KB/s。

    0:24:10240
    AdvancedOptions

    object

    進階選項。

    UdmDetail

    object

    整機備份進階選項。

    ExcludeDiskIdList

    array

    不需要保護的雲端硬碟 ID 列表。當 DiskIdList 不為空白時，將忽略該參數。

    string

    不需要保護的雲端硬碟 ID。

    d-bp1************apo

    DiskIdList

    array

    需要保護的雲端硬碟 ID 列表。保護所有雲端硬碟時，該值為空白。

    string

    需要保護的雲端硬碟 ID。

    d-bp1************apo

    SnapshotGroup

    boolean

    是否建立快照一致性組。僅雲端硬碟類型全部為 ESSD 時，支援建立快照一致性組。

    true
    AppConsistent

    boolean

    是否建立應用一致性。僅雲端硬碟類型全部為 ESSD 時，支援建立快照應用一致性。

    false
    RamRoleName

    string

    僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照需要配置的 RAM 角色名稱。

    AliyunECSInstanceForHbrRole
    PreScriptPath

    string

    僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照前執行的凍結指令碼路徑。

    /tmp/prescript.sh
    PostScriptPath

    string

    僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照後執行的解凍指令碼路徑。

    /tmp/postscript.sh
    EnableFsFreeze

    boolean

    僅當 AppConsistent 為 true 時，需要配置該參數。是否在建立應用一致性快照前使用 Linux 的 FsFreeze 機制確保檔案系統處於唯讀一致性。預設為 true。

    true
    TimeoutInSeconds

    integer

    僅當 AppConsistent 為 true 時，需要配置該參數。IO 凍結逾時時間。預設為 30 秒。

    30
    EnableWriters

    boolean

    僅當 AppConsistent 為 true 時，需要配置該參數。是否設定應用一致性快照：

    • true：建立應用一致性快照

    • false：建立檔案系統一致性快照

    預設為 true。

    true
    DestinationKmsKeyId

    string

    目標地區自訂 KMS 金鑰識別碼，該欄位不為空白且開啟異地複寫時，將使用該密鑰進行加密異地複寫。

    4ed37b1e-da51-4187-aceb-9db4f9b7148b
    OssDetail

    object

    OSS 備份進階選項。

    InventoryId

    string

    OSS 清單名稱，該值不為空白時將使用 OSS 清單用於效能調優。

    • 建議備份 1 億以上 OSS 對象採用清單提升增量效能，由資訊清單檔產生的儲存費用由 OSS 服務單獨收取。

    • OSS 資訊清單檔產生需要時間，在 OSS 資訊清單檔產生完成之前可能會備份失敗，可以等待下個周期執行。

    inventory_test
    InventoryCleanupPolicy

    string

    備份後是否刪除資訊清單檔。僅當使用 OSS 清單時有效。支援：

    • NO_CLEANUP：不刪除。

    • DELETE_CURRENT：刪除當前檔案。

    • DELETE_CURRENT_AND_PREVIOUS：刪除所有檔案。

    DELETE_CURRENT_AND_PREVIOUS
    IgnoreArchiveObject

    boolean

    不在任務統計和失敗檔案清單中提示歸檔型對象

    true
    FileDetail

    object

    檔案備份進階選項。

    UseVSS

    boolean

    是否啟用 VSS（Windows）功能。取值：

    • true：啟用。

    • false：不啟用。

    false
    AdvPolicy

    boolean

    是否使用進階策略。取值：

    • true：使用。

    • false：不適用。

    false
    CommonNasDetail

    object

    本地 NAS 進階選項。

    FullOnIncrementFail

    boolean

    增量備份失敗時是否轉為全量備份。取值：

    • true：失敗時轉為全量備份。

    • false：失敗時不轉為全量備份。

    true
    FetchSliceSize

    integer

    備份分區大小（檔案數）。

    100000
    ClientId

    string

    備份用戶端識別碼。

    c-0001eg6mcvjs93f46s2d
    ClusterId

    string

    用戶端組 ID。

    cl-000gkcofngi04j6k680a
    CommonFileSystemDetail

    object

    大規模檔案系統備份進階選項。

    FullOnIncrementFail

    boolean

    增量備份失敗時是否轉為全量備份。取值：

    • true：失敗時轉為全量備份。

    • false：失敗時不轉為全量備份。

    true
    FetchSliceSize

    integer

    備份分區大小（檔案數）。

    100000
    SourceType

    string

    資料來源類型，取值範圍：

    • UDM_ECS：表示 ECS 整機備份

    UDM_ECS
    CrossAccountType

    string

    跨帳號備份類型。支援：

    • SELF_ACCOUNT：本帳號備份

    • CROSS_ACCOUNT：跨帳號備份

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    跨帳號備份的原帳號 ID。

    1480************
    CrossAccountRoleName

    string

    用於跨帳號備份的原帳號 RAM 中建立的角色名稱。

    hbrcrossrole
    CreatedByTag

    boolean

    資源是否通過備份策略資源標籤自動關聯。

    false
    HitTags

    array<object>

    命中的標籤規則。

    object

    Key

    string

    標籤鍵。

    env
    Value

    string

    標籤值。

    prod
    Operator

    string

    標籤匹配規則。

    • EQUAL：匹配標籤鍵和標籤值。

    • NOT：匹配標籤鍵，不匹配標籤值。

    EQUAL
    NextToken

    string

    擷取下一頁策略與資料來源綁定所需的 Token。

    caeba0bbb2be03f84eb48b699f0a
    MaxResults

    integer

    每次查詢結果的個數。

    取值範圍：10~100。預設值：10。

    10
    TotalCount

    integer

    總記錄數。

    38
    Success

    boolean

    請求是否成功。

    • true：成功

    • false：失敗

    true
    Code

    string

    返回碼，200 表示成功。

    200
    Message

    string

    返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。

    successful
    RequestId

    string

    請求 ID。

    5225929A-4EBD-55EE-9FE1-4A130E582A76

    樣本

    正常返回樣本

    JSON格式

    {
  "PolicyBindings": [
    {
      "CreatedTime": 1661399570,
      "UpdatedTime": 1653611573,
      "PolicyBindingId": "pd-000************slc",
      "PolicyBindingDescription": "po-000************eslc-i-uf6************y5g",
      "PolicyId": "po-000************56y",
      "DataSourceId": "i-8vb************5ly",
      "Disabled": true,
      "Source": "backup/",
      "Include": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "Exclude": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "SpeedLimit": "0:24:10240",
      "AdvancedOptions": {
        "UdmDetail": {
          "ExcludeDiskIdList": [
            "d-bp1************apo\n"
          ],
          "DiskIdList": [
            "d-bp1************apo\n"
          ],
          "SnapshotGroup": true,
          "AppConsistent": false,
          "RamRoleName": "AliyunECSInstanceForHbrRole",
          "PreScriptPath": "/tmp/prescript.sh",
          "PostScriptPath": "/tmp/postscript.sh",
          "EnableFsFreeze": true,
          "TimeoutInSeconds": 30,
          "EnableWriters": true,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS",
          "IgnoreArchiveObject": true
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": "cl-000gkcofngi04j6k680a"
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole",
      "CreatedByTag": false,
      "HitTags": [
        {
          "Key": "env",
          "Value": "prod",
          "Operator": "EQUAL"
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

    錯誤碼

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

    變更歷史

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