All Products
Search

This Product

    Cloud Backup:DescribePolicyBindings

    Document Center

    Cloud Backup:DescribePolicyBindings

    Last Updated:Mar 03, 2024

    Queries one or more data sources bound to a backup policy or queries one or more backup policies bound to a data source.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    The current API does not require request parameters

    Response parameters

    ParameterTypeDescriptionExample
    object

    DescribePolicyBindingsResponse

    PolicyBindingsobject []

    The association between the backup policy and data sources.

    CreatedTimelong

    The time when the backup policy was created. This value is a UNIX timestamp. Unit: seconds.

    		1661399570
    UpdatedTimelong

    The time when the backup policy was updated. The value is a UNIX timestamp. Unit: seconds.

    		1653611573
    PolicyBindingIdstring

    The ID of the association.

    		pd-000************slc
    PolicyBindingDescriptionstring

    The description of the association.

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

    The policy ID.

    		po-000************56y
    DataSourceIdstring

    The ID of the data source.

    		i-8vb************5ly
    Disabledboolean

    Indicates whether the backup policy is enabled for the data source. Valid values:

    • true: The backup policy is disabled.
    • false: The backup policy is enabled.
    		true
    AdvancedOptionsobject

    The advanced options.

    UdmDetailobject

    The advanced options for ECS instance backup.

    ExcludeDiskIdListarray

    The IDs of the disks that do not need to be protected. If DiskIdList is not empty, this parameter is ignored.

    string

    The ID of the disk that does not need to be protected.

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

    The IDs of the disks that need to be protected. If all disks need to be protected, this parameter is empty.

    string

    The ID of the disk that needs to be protected.

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

    Indicates whether a snapshot-consistent group is created. You can create a snapshot-consistent group only if all disks are enhanced SSDs (ESSDs).

    		true
    AppConsistentboolean

    Indicates whether application consistency is enabled. You can enable application consistency only if all disks are ESSDs.

    		false
    RamRoleNamestring

    This parameter is returned only if AppConsistent is set to true. This parameter indicates the name of the RAM role that is required to create application-consistent snapshots.

    		AliyunECSInstanceForHbrRole
    PreScriptPathstring

    This parameter is returned only if AppConsistent is set to true. This parameter indicates the path of the pre-freeze scripts that are executed before application-consistent snapshots are created.

    		/tmp/prescript.sh
    PostScriptPathstring

    This parameter is returned only if AppConsistent is set to true. This parameter indicates the path of the post-thaw scripts that are executed after application-consistent snapshots are created.

    		/tmp/postscript.sh
    EnableFsFreezeboolean

    This parameter is returned only if AppConsistent is set to true. This parameter indicates whether Linux fsfreeze is enabled to put file systems into the read-only state before application-consistent snapshots are created. Default value: true.

    		true
    TimeoutInSecondslong

    This parameter is returned only if AppConsistent is set to true. This parameter indicates the I/O freeze timeout period. Default value: 30. Unit: seconds.

    		30
    EnableWritersboolean

    This parameter is returned only if AppConsistent is set to true. This parameter indicates whether application-consistent snapshots are created. Valid values:

    • true: Application-consistent snapshots are created.
    • false: File system-consistent snapshots are created.

    Default value: true.

    		true
    OssDetailobject

    The advanced options for OSS backup.

    InventoryIdstring

    The name of the OSS inventory. If this parameter is not empty, the OSS inventory is used for performance optimization.

    • If you want to back up more than 100 million OSS objects, we recommend that you use inventory lists to accelerate incremental backup. Storage fees for inventory lists are included into your OSS bills.
    • A certain amount of time is required for OSS to generate inventory lists. Before inventory lists are generated, OSS objects may fail to be backed up. In this case, you can back up the OSS objects in the next backup cycle.
    		inventory_test
    InventoryCleanupPolicystring

    Indicates whether the system deletes the inventory lists when a backup is completed. This parameter is valid only when OSS inventories are used. Valid values:

    • NO_CLEANUP: Inventory lists are not deleted.
    • DELETE_CURRENT: The current inventory list is deleted.
    • DELETE_CURRENT_AND_PREVIOUS: All inventory lists are deleted.
    		DELETE_CURRENT_AND_PREVIOUS
    FileDetailobject

    The advanced options for file backup.

    UseVSSboolean

    Indicates whether the Volume Shadow Copy Service (VSS) feature is enabled. Valid values:

    • true: The feature is enabled.
    • false: The feature is disabled.
    		false
    AdvPolicyboolean

    Indicates whether an advanced policy is used. Valid values:

    • true
    • false
    		false
    CommonNasDetailobject

    The advanced options for on-premises NAS backup.

    FullOnIncrementFailboolean

    Indicates whether the system performs full backup if incremental backup fails. Valid values:

    • true: The system performs full backup if incremental backup fails.
    • false: The system does not perform full backup if incremental backup fails.
    		true
    FetchSliceSizelong

    The size of backup shards (the number of files).

    		100000
    ClientIdstring

    The ID of the HBR client.

    		c-0001eg6mcvjs93f46s2d
    SourceTypestring

    The type of the data source. Valid values:

    • UDM_ECS: ECS instances
    		UDM_ECS
    CrossAccountTypestring

    Indicates whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:

    • SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.
    • CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.
    		CROSS_ACCOUNT
    CrossAccountUserIdlong

    The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

    		1480************
    CrossAccountRoleNamestring

    The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

    		hbrcrossrole

    Examples

    Sample success responses

    JSONformat

    {
  "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,
      "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"
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": ""
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-01-05The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2023-12-12The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2023-08-16The request parameters of the API has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Filters
    Output ParametersThe response structure of the API has changed.
    2023-03-29The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.