UpdateScheduledBackupConfig - 配置备份策略 - 实时数仓Hologres

配置备份策略。以周为周期，可以指定一周内的数个固定日期启动实例备份，比如周一、周三、周五的20:00:00。已完成的备份，可以配置保留个数，过期的备份会被自动清理。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 id。	cn-beijing
body	object	否	请求体参数。
instanceId	string	否	实例 id。	hgprecn-cn-zvp25ysxxxx
enabled	boolean	否	是否开启周期备份。true 开启，false 关闭。	true
week	string	否	备份日期的周配置，可以配置多个，英文逗号分隔，比如配置周一、周三、周五，参数为"1,3,5".	1,3,5
hour	integer	否	备份日期的开始时间点，备份任务将在开始时间点启动。时间点对所有有效日期生效，比如 week 配置了 1,3,5, hour 配置 20，那么，每周一、周三、周五的 20:00:00 都会开始备份。	20
dataKeepQuantity	integer	否	周期备份保留个数，比如配置 3，系统会自动保留最新的 3 个备份，其余过期备份会被自动清理。	3
dstRegion	string	否	备份目标地域。仅对远程备份生效，支持将本地域数据备份到其他地域，实现跨地域容灾。比如杭州的实例，可以跨地域备份到北京。	cn-beijing
zoneId	string	否	备份目标可用区。仅对远程备份生效	cn-beijing-i
manualDataKeepQuantity	integer	否	手动备份保留个数。手动备份和自动备份分开存储，保留策略完全分开。	3
scheduleType	string	否	备份类型。仅远程备份需要配置此字段，其余类型可以忽略。枚举值： periodical : 周期备份 remote : 远程备份	remote

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	69221013-D303-5046-91A7-A0BE2BC2E7D7
Data	boolean	true：成功；false：失败	True
Success	boolean	请求是否成功。	True
ErrorCode	string	错误码。	null
ErrorMessage	string	错误信息。	null
HttpStatusCode	string	http 状态码。	200

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。