UpdateScheduledBackupConfig - Hologres - Alibaba Cloud Documentation Center

This operation configures a backup policy for an instance. You can set a weekly schedule to back up an instance on specific days, such as every Monday, Wednesday, and Friday at 20:00:00. You can also specify the number of completed backups to retain. The system automatically deletes expired backups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/backups/scheduledConfig HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
body	object	No	The request body.
instanceId	string	No	The instance ID.	hgprecn-cn-zvp25ysxxxx
enabled	boolean	No	Specifies whether to enable scheduled backups. Set this parameter to `true` to enable scheduled backups, or `false` to disable them.	true
week	string	No	Specifies the days of the week on which to perform a backup. Separate multiple days with commas. For example, to perform backups on Monday, Wednesday, and Friday, set this parameter to `1,3,5`.	1,3,5
hour	integer	No	The hour to start the backup. This start time applies to all specified days. For example, if you set `week` to `1,3,5` and `hour` to `20`, a backup starts at 20:00:00 every Monday, Wednesday, and Friday.	20
dataKeepQuantity	integer	No	The number of scheduled backups to retain. For example, if you set this parameter to `3`, the system retains the three most recent backups and automatically deletes any older ones.	3
dstRegion	string	No	The destination region for the backup. This parameter applies only to remote backups and enables cross-region disaster recovery. For example, you can back up an instance from China (Hangzhou) to China (Beijing).	cn-beijing
zoneId	string	No	The destination availability zone for the backup. This parameter applies only to remote backups.	cn-beijing-i
manualDataKeepQuantity	integer	No	The number of manual backups to retain. Manual backups and automatic backups are stored separately and have independent retention policies.	3
scheduleType	string	No	The backup type. This parameter is required only for remote backups. Valid values: periodical : scheduled backup remote : remote backup	remote

Response elements

Element	Type	Description	Example
	object	The data returned by the operation.
RequestId	string	The request ID.	69221013-D303-5046-91A7-A0BE2BC2E7D7
Data	boolean	Indicates whether the configuration was successful. A value of `true` indicates success, and `false` indicates failure.	True
Success	boolean	Indicates whether the request was successful.	True
ErrorCode	string	The error code returned if the request fails.	null
ErrorMessage	string	The error message returned if the request fails.	null
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "69221013-D303-5046-91A7-A0BE2BC2E7D7",
  "Data": true,
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.