获取备份配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/backups/scheduledConfig HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 id。 |
cn-shenzhen |
| instanceId |
string |
否 |
实例 id。 |
hgprecn-cn-9lb3bjg1n003 |
| scheduleType |
string |
否 |
备份类型。默认返回周期和手动备份配置,如需返回远程备份配置,需要填写 remote 枚举值:
|
remote |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
Id of the request |
623EF0B6-A6C1-5764-82CC-0BC176654CB9 |
| Success |
boolean |
请求是否成功。 |
true |
| ErrorCode |
string |
错误码。 |
null |
| ErrorMessage |
string |
错误信息。 |
null |
| HttpStatusCode |
string |
http 状态码。 |
200 |
| Data |
object |
返回数据。 |
|
| Enabled |
integer |
配置是否生效,取值:-true:生效-false:不生效 |
true |
| TaskParameter |
string |
任务参数。 |
{"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 |
任务类型。 |
backup |
示例
正常返回示例
JSON格式
{
"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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。