GetScheduledBackupConfig - Hologres - Alibaba Cloud Documentation Center

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

GET /api/v1/backups/scheduledConfig HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shenzhen
instanceId	string	No	The instance ID.	hgprecn-cn-9lb3bjg1n003
scheduleType	string	No	The backup type. By default, the operation returns periodical and manual backup configurations. To retrieve the remote backup configuration, set this parameter to 'remote'. Valid values: periodical : A periodical backup. remote : A remote backup.	remote

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	623EF0B6-A6C1-5764-82CC-0BC176654CB9
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	null
ErrorMessage	string	The error message.	null
HttpStatusCode	string	The HTTP status code.	200
Data	object	The returned data.
Enabled	integer	Indicates whether the backup configuration is enabled. Valid values: 1 (enabled) and 0 (disabled).	true
TaskParameter	string	The task parameter.	{"schedule":"0 10 * * 1,2","instance_id":"hgprecn-cn-lbj3dfgog004","week":"1,2","hour":10,"data_keep_quantity":3,"type":"periodical","enabled":true}
TaskType	string	The task type.	backup

Examples

Success response

JSON format

{
  "RequestId": "623EF0B6-A6C1-5764-82CC-0BC176654CB9",
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200",
  "Data": {
    "Enabled": 0,
    "TaskParameter": "{\"schedule\":\"0 10 * * 1,2\",\"instance_id\":\"hgprecn-cn-lbj3dfgog004\",\"week\":\"1,2\",\"hour\":10,\"data_keep_quantity\":3,\"type\":\"periodical\",\"enabled\":true}",
    "TaskType": "backup\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.