Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
8.8 KiB
Querying an Automated Backup Policy
Function
This API is used to query an automated backup policy.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
instance_id
Yes
Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.
Requests
Responses
- Parameter description
Table 2 Parameter description Name
Type
Description
backup_policy
Object
Indicates the backup policy object, including the backup retention period (days) and start time. For more information, see Table 3.
Table 3 backup_policy field data structure description Name
Type
Description
keep_days
Integer
Indicates the number of days to retain the backup files.
start_time
String
Indicates the backup time window. Automated backups will be triggered during the backup time window.
period
String
Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week.
- Response exampleIn case the automated backup policy is enabled:
{ "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,4,5,6" } }
In case the automated backup policy is disabled:{ "backup_policy": { "keep_days": 0 } }
Error Code
For more information, see Error Code.