Querying an Automated Backup Policy¶
Function¶
This API is used to query an automated backup policy. Before using this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
GET /v3/{project_id}/instances/{instance_id}/backups/policy
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
backup_policy | BackupPolicy object | Backup policy information. |
Parameter | Type | Description |
---|---|---|
keep_days | Integer | Backup retention days. Value: 1 to 732 Minimum value: 1 Maximum value: 732 |
start_time | String | Backup time window. Automated backups will be triggered during the backup time window. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. |
period | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. Value range: The value is a number separated by commas (,), indicating the days of the week. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy
Example Response¶
Status code: 200
Success.
{
"backup_policy" : {
"keep_days" : "7,",
"start_time" : "19:00-20:00",
"period" : "1,2"
}
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.