Querying the Backup Policy Bound to HSS Protection Vault

Function

This API is used to query the backup policy bound to the HSS protection vault. Ensure that a ransomware protection vault has been purchased in CBR. Such a vault is named in the HSS_projectid format.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/backup/policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768
region	Yes	String	region id Minimum: 0 Maximum: 128

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
enabled	Boolean	Whether the policy is enabled
id	String	Policy ID Minimum: 1 Maximum: 128
name	String	Policy name Minimum: 1 Maximum: 128
operation_type	String	Backup type. Its value can be: backup replication Minimum: 1 Maximum: 128
operation_definition	OperationDefinitionInfo object	Policy attribute. Reserved rule.
trigger	BackupTriggerInfo object	Backup policy scheduling rule

**Table 5** OperationDefinitionInfo
Parameter	Type	Description
day_backups	Integer	Maximum number of retained daily backups. The latest backup of each day is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100
max_backups	Integer	Maximum number of automated backups that can be retained for an object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity limit is exceeded. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 Minimum: -1 Maximum: 99999
month_backups	Integer	Maximum number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100 If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100
retention_duration_days	Integer	Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared even though the configured retention duration is exceeded. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 Minimum: -1 Maximum: 99999
timezone	String	Time zone where the user is located, for example, UTC+08:00. Set this parameter only after you have configured any of the parameters day_backups, week_backups, month_backups, and year_backups. Minimum: 0 Maximum: 256
week_backups	Integer	Maximum number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum: 0 Maximum: 100
year_backups	Integer	Maximum number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100

**Table 6** BackupTriggerInfo
Parameter	Type	Description
id	String	Scheduler ID Minimum: 0 Maximum: 256
name	String	Scheduler name Minimum: 0 Maximum: 256
type	String	Scheduler type. Currently, only time can be configured. Minimum: 0 Maximum: 256
properties	BackupTriggerPropertiesInfo object	Scheduler attribute

**Table 7** BackupTriggerPropertiesInfo
Parameter	Type	Description
pattern	Array of strings	Scheduling policy. The value contains a maximum of 10,240 characters and complies with iCalendar RFC 2445. However, only FREQ, BYDAY, BYHOUR, and BYMINUTE are supported. FREQ can be set to only WEEKLY or DAILY. BYDAY can be set to the seven days in a week (MO, TU, WE, TH, FR, SA and SU). BYHOUR can be set to 0 to 23 hours. BYMINUTE can be set to 0 to 59 minutes. The interval between time points cannot be less than one hour. Multiple backup time points can be set in a backup policy, and up to 24 time points can be set for a day. Minimum: 0 Maximum: 256 Array Length: 0 - 24
start_time	String	Scheduler start time. Example: 2020-01-08 09:59:49 Minimum: 0 Maximum: 256

Example Requests

This API is used to query the backup policy associated with the vault.

GET https://{endpoint}/v5/{project_id}/backup/policy

Example Responses

Status code: 200

Backup policy information

{
  "enabled" : true,
  "id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "name" : "HSS_84b5266c14ae489fa6549827f032dc62",
  "operation_type" : "backup",
  "operation_definition" : {
    "day_backups" : 0,
    "max_backups" : "-1",
    "month_backups" : 0,
    "retention_duration_days" : 5,
    "timezone" : "UTC+08:00",
    "week_backups" : 0,
    "year_backups" : 0
  },
  "trigger" : {
    "properties" : {
      "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
    }
  }
}