Querying an Automated Backup Policy¶
Function¶
This API is used to query an automated backup policy. Before calling this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
URI format
GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy
Example
Parameter description
¶ Name
Type
Mandatory
Description
project_id
String
Yes
Project ID of a tenant in a region.
To obtain this value, see Obtaining a Project ID.
instance_id
String
Yes
DB instance ID.
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
backup_policy | BackupPolicy object | Backup policy information. |
Parameter | Type | Description |
---|---|---|
keep_days | Integer | Backup retention days. |
start_time | String | Backup time window. Automated backups will be triggered during the backup time window. |
period | String | Backup cycle configuration. Data will be automatically backed up on the selected days every 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/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/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.