DescribePoliciesV2 - Cloud Backup - Alibaba Cloud Documentation Center

Queries one or more backup policies.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that is used to obtain the next page of backup policies.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	No	The number of results for each query. Valid values: 10 to 100. Default value: 10.	10
PolicyId	string	No	The ID of the backup policy.	po-000************2l6

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Policies	object []	The backup policies.
CreatedTime	long	The time when the backup policy was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1650248136
UpdatedTime	long	The time when the backup policy was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1662080404
PolicyId	string	The ID of the backup policy.	po-000************bkz
PolicyName	string	The name of the backup policy.	Daily Local Backup + Remote Backup
PolicyDescription	string	The description of the backup policy.	Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region for geo-redundancy.
Rules	object []	The rules in the backup policy.
RuleId	string	The rule ID.	rule-000************f1e
RuleType	string	The type of the rule. Each backup policy must have at least one rule of the BACKUP type and only one rule of the TRANSITION type. BACKUP: the backup rule. TRANSITION: the lifecycle rule. REPLICATION: the replication rule.	BACKUP
Schedule	string	This parameter is returned only if the value of the RuleType parameter is BACKUP. This parameter indicates the scheduling settings for the backups. Format: `I\|{startTime}\|{interval}`. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is complete. For example, `I\|1631685600\|P1D` indicates that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day. startTime: the time when the system starts to run a backup job. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. interval: the interval at which the system runs a backup job. The interval must follow the ISO 8601 standard. For example, PT1H indicates an interval of one hour. P1D indicates an interval of one day.	I\|1648647166\|P1D
BackupType	string	This parameter is returned only if the value of the RuleType parameter is BACKUP. This parameter indicates the backup type. Only COMPLETE may be returned, which indicates full backup.	COMPLETE
ReplicationRegionId	string	This parameter is returned only if the value of the RuleType parameter is REPLICATION. This parameter indicates the ID of the destination region.	cn-shanghai
Retention	long	This parameter is returned only if the value of the RuleType parameter is TRANSITION or REPLICATION. If the value of the RuleType parameter is TRANSITION, this parameter indicates the retention period of the backup data. Minimum value: 1. Unit: days. If the value of the RuleType parameter is REPLICATION, this parameter indicates the retention period of remote backups. Minimum value: 1. Unit: days.	7
RetentionRules	object []	This parameter is returned only if the value of the RuleType parameter is TRANSITION. This parameter indicates the special retention rules.
AdvancedRetentionType	string	The type of the special retention rule. Valid values: WEEKLY: weekly backups. MONTHLY: monthly backups. YEARLY: yearly backups.	YEARLY
WhichSnapshot	long	Indicates which backup is retained based on the special retention rule. Only the first backup can be retained.	1
Retention	long	The retention period of the backup data. Minimum value: 1. Unit: days.	730
KeepLatestSnapshots	long	Indicates whether the feature of keeping at least one backup version is enabled. Valid values: 0: This feature is disabled. 1: This feature is enabled.	1
PolicyBindingCount	long	The number of data sources that are bound to the backup policy.	5
NextToken	string	The token that is used to obtain the next page of backup policies.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	The number of results for each query. Valid values: 10 to 100. Default value: 10.	10
TotalCount	long	The total number of returned entries.	12
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "Policies": [
    {
      "CreatedTime": 1650248136,
      "UpdatedTime": 1662080404,
      "PolicyId": "po-000************bkz",
      "PolicyName": "Daily Local Backup + Remote Backup\n",
      "PolicyDescription": "Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region for geo-redundancy.\n",
      "Rules": [
        {
          "RuleId": "rule-000************f1e",
          "RuleType": "BACKUP",
          "Schedule": "I|1648647166|P1D",
          "BackupType": "COMPLETE",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "KeepLatestSnapshots": 1
        }
      ],
      "PolicyBindingCount": 5
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history