修改数据库定时任务策略模板 - ModifyJobSchedule
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds::updateDbJobSchedules | write | - | - | rds::updateDbJobSchedules | - |
URI
- URI格式
PUT /v3/{project_id}/db-job/schedules/{schedule_id}
- 参数说明
表1 参数说明 参数
是否必选
参数类型
描述
project_id
是
String
参数解释:
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
schedule_id
是
String
参数解释:
策略ID。
可调用查询数据库定时任务策略模板列表接口,通过表4中的“id”获取。
约束限制:
非空。
取值范围:
不涉及。
默认取值:
不涉及。
请求参数
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| job_schedule_type | 否 | String | 参数解释: 计划类型。 取值范围:
|
| one_time_occurrence | 否 | Object | 参数解释: 执行一次执行时间。 详情请参见表3。 |
| frequency | 否 | Object | 参数解释: 策略间隔周期。仅当策略ID为空时生效。 详情请参见表4。 |
| daily_frequency | 否 | Object | 参数解释: 策略每日频率。仅当策略ID为空时生效。 详情请参见表5。 |
| duration | 否 | Object | 参数解释: 策略有效期。仅当策略ID为空时生效。 详情请参见表6。 |
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| active_start_date | 是 | String | 参数解释: 执行日期,格式:yyyy-MM-dd。 取值范围: 1990-01-01~2099-12-31 |
| active_start_time | 是 | String | 参数解释: 执行时间,格式:HH:mm:ss。 取值范围: 不涉及。 |
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| freq_type | 是 | String | 参数解释: 策略频率类型。 取值范围:
|
| freq_interval | 是 | Integer | 参数解释: 执行间隔。 取值范围: 1~99 |
| freq_interval_weekly | 否 | Array of strings | 参数解释: 每周执行哪几天。 取值范围: 策略频率类型为按周时返回该参数值,不为按周时不生效。 Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday。 |
| freq_interval_day_monthly | 否 | Integer | 参数解释: 每月执行的日期。 取值范围: 策略频率类型为按月、每月按天时返回该参数值,不为按月、每月按天时不生效。 1~当月总天数,例如1~31。 |
| freq_interval_monthly | 否 | String | 参数解释: 当月按周执行哪几天。 取值范围: 策略频率类型为按月、每月按周时返回该参数值,不为按月、每月按周时不生效。 Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,day,weekday,weekend。 |
| freq_relative_interval_monthly | 否 | String | 参数解释: 每月在哪周执行。 取值范围: 策略频率类型为按月、每月按周时返回该参数值,不为按月、每月按周时不生效。 first,second,third,fourth,last。 |
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| freq_subday_type | 是 | String | 参数解释: 每日频率类型。 取值范围:
|
| active_start_time | 是 | String | 参数解释: 每日第一次执行时间。每日频率类型为每日一次时,则只执行这一次,格式:HH:mm:ss。 取值范围: 不涉及。 |
| active_end_time | 否 | String | 参数解释: 最后一次执行时间,格式:HH:mm:ss。 取值范围: 每日执行多次时返回该参数值,每日执行一次时不生效。 |
| freq_subday_interval | 否 | Integer | 参数解释: 执行间隔。 取值范围: 每日执行多次时返回该参数值,每日执行一次时不生效。 1~99 |
| freq_interval_unit | 否 | String | 参数解释: 执行间隔的单位。 取值范围: 每日执行多次时返回该参数值,每日执行一次时不生效。
|
请求示例
PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/db-job/schedules/a59096a6-143c-4478-bec6-92b6b516d138
{
"frequency" : {
"freq_type" : "daily",
"freq_interval" : 1
},
"daily_frequency" : {
"freq_subday_type" : "once",
"active_start_time" : "02:00:00"
},
"duration" : {
"active_start_date" : "1970-01-02",
"active_end_date" : "2099-12-31"
}
} 响应消息
- 正常响应要素说明
表7 参数说明 参数
参数类型
描述
resp
String
参数解释:
调用结果。
取值范围:
调用正常时,返回“successful”。
- 正常响应样例
{ "resp": "successful" }
- 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。