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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/backup/policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
enabled	Boolean	Definition Whether the policy is enabled. Range true: The policy is enabled. false: The policy is disabled.
id	String	Definition Policy ID. Range The value can contain 1 to 128 characters.
name	String	Definition Policy name. Range The value can contain 1 to 128 characters.
operation_type	String	Definition Backup type. Range backup
operation_definition	OperationDefinitionInfo object	Definition Policy attribute. Reserved rule. Range N/A
trigger	BackupTriggerInfo object	Definition Backup policy scheduling rule. Range N/A

**Table 5** OperationDefinitionInfo
Parameter	Type	Description
day_backups	Integer	Definition Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Range The value range is 0 to 100.
max_backups	Integer	Definition Maximum number of backups that can be automatically created for a backup object. If the value is set to -1, backups will not be cleared when they reach the quantity limit. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently. Range The value can be -1 or in the range 1 to 99,999.
month_backups	Integer	Definition Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Range The value range is 0 to 100.
retention_duration_days	Integer	Definition Backup retention period, in days. The maximum value is 99,999. If the value is set to -1, backups will not be cleared by retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. Range Minimum value: -1; maximum value: 99,999
timezone	String	Definition Time zone where the user is located, for example, UTC+08:00 Constraints This parameter cannot be set if none of the yearly, monthly, weekly, and daily backup parameters is selected. Range The value contains 1 to 256 characters. Default Value N/A
week_backups	Integer	Definition Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Range UTC+05:00 UTC+06:00 UTC+07:00 ...
year_backups	Integer	Definition Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Range The value range is 0 to 100.

**Table 6** BackupTriggerInfo
Parameter	Type	Description
id	String	Definition Scheduler ID Range The value contains 0 to 256 characters.
name	String	Definition Scheduler name Range The value contains 0 to 256 characters.
type	String	Definition Scheduler type. Currently, only time is supported. Range The value contains 0 to 256 characters.
properties	BackupTriggerPropertiesInfo object	Scheduler attribute

**Table 7** BackupTriggerPropertiesInfo
Parameter	Type	Description
pattern	Array of strings	Definition Scheduling policy of the scheduler. Range 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.
start_time	String	Definition Scheduler start time. Example: 2020-01-08 09:59:49 Range The value contains 0 to 256 characters.

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

Request succeeded.

{
  "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" ]
    }
  }
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Ransomware Prevention

Previous topic: Ransomware Prevention

Next topic: Modifying the Backup Policy Bound to Vault

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot