DescribePolicyBindings - Cloud Backup - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query one or more data sources bound to a policy, or query one or more policies bound to a data source.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hbr:DescribePolicyBindings	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	Token required to fetch the next page of policy and data source associations.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	No	Number of results per query. Range: 10~100. Default: 10.	10
PolicyId	string	No	Policy ID.	po-000************hky
DataSourceIds	array	No	List of data source IDs.
	string	No	Data source ID.	i-uf6************68n
SourceType	string	No	Data source type. Possible values: UDM_ECS: Indicates ECS full machine backup.	UDM_ECS
Filters	array<object>	No	Query filters.
	object	No	Query filters.
Key	string	No	Key in the query filter. Possible values include: PolicyId: Backup policy ID DataSourceId: ECS instance ID DataSourceType: Data source type	DataSourceType
Operator	string	No	Matching method. Default is IN. This refers to the matching operation (Operator) supported by the Key and Value in the filter. Possible values include: EQUAL: Equal to NOT_EQUAL: Not equal to GREATER_THAN: Greater than GREATER_THAN_OR_EQUAL: Greater than or equal to LESS_THAN: Less than LESS_THAN_OR_EQUAL: Less than or equal to BETWEEN: Range, where value is a JSON array `[lower_bound, upper_bound]`. IN: In the set, where value is an array.	IN
Values	array	No	Values to be matched in the query filter.
	string	No	Values to be matched in the query filter.	UDM_ECS

Response parameters

Parameter	Type	Description	Example
	object	DescribePolicyBindingsResponse
PolicyBindings	array<object>	List of bound policies.
Data	object	Details of the bound policy.
CreatedTime	long	Creation time. UNIX timestamp, in seconds.	1661399570
UpdatedTime	long	Update time. UNIX timestamp, in seconds.	1653611573
PolicyBindingId	string	Bound policy ID.	pd-000************slc
PolicyBindingDescription	string	Bound policy description.	po-000**********eslc-i-uf6**********y5g
PolicyId	string	Policy ID.	po-000************56y
DataSourceId	string	Data source ID.	i-8vb************5ly
Source	string	When SourceType is OSS, it indicates the prefix to be backed up. If not specified, it means backing up the entire root directory of the Bucket. When SourceType is ECS_FILE or File, it indicates the file directory to be backed up. If not specified, it means backing up all directories.	backup/
Include	string	This parameter is required only when SourceType is ECS_FILE or File. It specifies the file types to be backed up, and all files of these types will be backed up. Supports up to 255 characters.	[\".doc\",\".xltm\"]
Exclude	string	This parameter is required only when SourceType is ECS_FILE or File. It specifies the file types that should not be backed up, and all files of these types will be excluded. Supports up to 255 characters.	[\".doc\",\".xltm\"]
SpeedLimit	string	This parameter is required only when SourceType is ECS_FILE or File. It specifies the backup traffic control. The format is `{start}{end}{bandwidth}`. Multiple traffic control configurations are separated by commas, and the configured times must not overlap. start: Start hour. end: End hour. bandwidth: Limit rate, in KB/s.	0:24:10240
AdvancedOptions	object	Advanced options.
UdmDetail	object	Advanced options for full machine backup.
ExcludeDiskIdList	array	List of disk IDs that do not need protection. This parameter is ignored if DiskIdList is not empty.
ExcludeDiskIdList	string	Disk ID that does not need protection.	d-bp1************apo
DiskIdList	array	List of disk IDs that need protection. This value is empty when protecting all disks.
DiskIdList	string	Disk ID that needs protection.	d-bp1************apo
SnapshotGroup	boolean	Indicates whether to create a snapshot consistency group. Only supported when all disk types are ESSD.	true
RamRoleName	string	This parameter is required when AppConsistent is true. It specifies the RAM role name needed for creating an application-consistent snapshot.	AliyunECSInstanceForHbrRole
PreScriptPath	string	This parameter is required when AppConsistent is true. It specifies the path of the freeze script to be executed before creating an application-consistent snapshot.	/tmp/prescript.sh
PostScriptPath	string	This parameter is required when AppConsistent is true. It specifies the path of the unfreeze script to be executed after creating an application-consistent snapshot.	/tmp/postscript.sh
EnableFsFreeze	boolean	This parameter is required when AppConsistent is true. It indicates whether to use the Linux FsFreeze mechanism to ensure the file system is in a read-only consistent state before creating an application-consistent snapshot. The default value is true.	true
TimeoutInSeconds	long	This parameter is required when AppConsistent is true. It specifies the IO freeze timeout duration. The default value is 30 seconds.	30
EnableWriters	boolean	This parameter is required when AppConsistent is true. It determines whether to set an application-consistent snapshot: true: Create an application-consistent snapshot false: Create a file system-consistent snapshot The default value is true.	true
DestinationKmsKeyId	string	The custom KMS key ID in the destination region. When this field is not empty and cross-region replication is enabled, the specified key will be used for encrypting the cross-region replication.	4ed37b1e-da51-4187-aceb-9db4f9b7148b
OssDetail	object	Advanced options for OSS backup.
InventoryId	string	The name of the OSS inventory. If this value is not empty, the OSS inventory will be used for performance optimization. It is recommended to use an inventory for backing up more than 100 million OSS objects to improve incremental performance. Storage costs for the inventory files are charged separately by the OSS service. The generation of the OSS inventory file takes time, and the backup may fail before the inventory file is generated. You can wait for the next cycle to execute.	inventory_test
InventoryCleanupPolicy	string	Whether to delete the inventory file after the backup. This is only effective when using an OSS inventory. Supported values: NO_CLEANUP: Do not delete. DELETE_CURRENT: Delete the current file. DELETE_CURRENT_AND_PREVIOUS: Delete all files.	DELETE_CURRENT_AND_PREVIOUS
IgnoreArchiveObject	boolean	Do not prompt for archive-type objects in the task statistics and failed file list.	true
FileDetail	object	Advanced options for file backup.
UseVSS	boolean	Whether to enable VSS (Windows) functionality. Values: true: Enable. false: Disable.	false
AdvPolicy	boolean	Whether to use advanced policies. Values: true: Use. false: Do not use.	false
CommonNasDetail	object	Advanced options for local NAS.
FullOnIncrementFail	boolean	Whether to switch to a full backup when an incremental backup fails. Values: true: Switch to full backup on failure. false: Do not switch to full backup on failure.	true
FetchSliceSize	long	Backup slice size (number of files).	100000
ClientId	string	Backup client ID.	c-0001eg6mcvjs93f46s2d
ClusterId	string	Client group ID.	cl-000gkcofngi04j6k680a
CommonFileSystemDetail	object	Advanced options for large-scale file system backup.
FullOnIncrementFail	boolean	Whether to switch to a full backup when an incremental backup fails. Values: true: Switch to full backup on failure. false: Do not switch to full backup on failure.	true
FetchSliceSize	long	Backup shard size (number of files).	100000
SourceType	string	Data source type, with the value range: UDM_ECS: indicates ECS full machine backup	UDM_ECS
CrossAccountType	string	Cross-account backup type. Supported values: SELF_ACCOUNT: Backup within the same account CROSS_ACCOUNT: Cross-account backup	CROSS_ACCOUNT
CrossAccountUserId	long	The ID of the original account for cross-account backup.	1480************
CrossAccountRoleName	string	The name of the role created in the RAM of the original account for cross-account backup.	hbrcrossrole
CreatedByTag	boolean	Whether the resource is automatically associated through the backup policy resource tag.	false
HitTags	array<object>	Hit tag rules.
HitTag	object
Key	string	Tag key.	env
Value	string	Tag value.	prod
Operator	string	Tag matching rule. EQUAL: Matches both the tag key and tag value. NOT: Matches the tag key but not the tag value.	EQUAL
NextToken	string	The token required to fetch the next page of policy and data source bindings.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	The number of results per query. Range: 10~100. Default: 10.	10
TotalCount	long	Total number of records.	38
Success	boolean	Indicates whether the request was successful. true: Success false: Failure	true
Code	string	Return code, 200 indicates success.	200
Message	string	Description of the return message. A successful response usually returns 'successful', while an error will return a corresponding error message.	successful
RequestId	string	Request ID.	5225929A-4EBD-55EE-9FE1-4A130E582A76

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,
      "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"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-13	The response structure of the API has changed	View Change Details
2024-09-25	The response structure of the API has changed	View Change Details
2024-03-13	The response structure of the API has changed	View Change Details
2024-01-05	The response structure of the API has changed	View Change Details
2023-12-12	The response structure of the API has changed	View Change Details
2023-08-16	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-03-29	The response structure of the API has changed	View Change Details