文档首页/ 云数据库 RDS/ API参考/ API v3/ 发布订阅(SQL Server)/ 创建数据库定时任务策略模板 - CreateJobSchedule
更新时间:2026-09-14 GMT+08:00
分享

创建数据库定时任务策略模板 - CreateJobSchedule

功能介绍

创建数据库定时任务策略模板。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds::createDbJobSchedules

write

-

-

rds::createDbJobSchedules

-

URI

  • URI格式

    POST /v3/{project_id}/db-job/schedules

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求参数

表2 请求body参数说明

参数

是否必选

参数类型

描述

schedule_type

String

参数解释:

策略类型。

约束限制:

不涉及。

取值范围:

  • snapshot:快照策略。
  • sync:同步策略。

默认取值

不涉及。

job_schedule_type

String

参数解释:

计划类型。

约束限制:

不涉及。

取值范围:

  • automatically:SQL Server代理启动时自动启动。
  • cpu_idle:CPU空闲时启动。
  • recurring:重复执行。
  • one_time:执行一次。

默认取值

不涉及。

one_time_occurrence

Object

参数解释:

执行一次执行时间。

详情请参见表3

约束限制:

不涉及。

frequency

Object

参数解释:

策略间隔周期。仅当策略ID为空时生效。

详情请参见表4

约束限制:

不涉及。

daily_frequency

Object

参数解释:

策略每日频率。仅当策略ID为空时生效。

详情请参见表5

约束限制:

不涉及。

duration

Object

参数解释:

策略有效期。仅当策略ID为空时生效。

详情请参见表6

约束限制:

不涉及。

表3 one_time_occurrence元素结构说明

参数

是否必选

参数类型

描述

active_start_date

String

参数解释:

执行日期,格式:yyyy-MM-dd。

约束限制:

不涉及。

取值范围:

1990-01-01~2099-12-31

默认取值

不涉及。

active_start_time

String

参数解释:

执行时间,格式:HH:mm:ss。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

表4 frequency元素结构说明

参数

是否必选

参数类型

描述

freq_type

String

参数解释:

策略频率类型。

约束限制:

不涉及。

取值范围:

  • daily:按天。
  • weekly:按周。
  • monthly_day:按月、每月按天。
  • monthly_week:按月、每月按周。

默认取值

不涉及。

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。

默认取值

不涉及。

表5 daily_frequency元素结构说明

参数

是否必选

参数类型

描述

freq_subday_type

String

参数解释:

每日频率类型。

约束限制:

不涉及。

取值范围:

  • once:每日一次。
  • multiple:每日多次。

默认取值

不涉及。

active_start_time

String

参数解释:

每日第一次执行时间。每日频率类型为每日一次时,则只执行这一次,格式:HH:mm:ss。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

active_end_time

String

参数解释:

最后一次执行时间,格式:HH:mm:ss。

约束限制:

每日执行多次时返回该参数值,每日执行一次时不生效。

取值范围:

不涉及。

默认取值

不涉及。

freq_subday_interval

Integer

参数解释:

执行间隔。

约束限制:

每日执行多次时返回该参数值,每日执行一次时不生效。

取值范围:

1~99

默认取值

不涉及。

freq_interval_unit

String

参数解释:

执行间隔的单位。

约束限制:

每日执行多次时返回该参数值,每日执行一次时不生效。

取值范围:

  • second:秒。
  • minute:分。
  • hour:时。

默认取值

不涉及。

表6 duration元素结构说明

参数

是否必选

参数类型

描述

active_start_date

String

参数解释:

第一次执行日期,格式:yyyy-MM-dd。

约束限制:

不涉及。

取值范围:

1990-01-01~2099-12-31

默认取值

不涉及。

active_end_date

String

参数解释:

最后一次执行日期,默认不会结束,格式:yyyy-MM-dd。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

请求示例

创建定时任务模板
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/db-job/schedules 
 
{ 
  "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" 
  }, 
  "schedule_type" : "snapshot" 
}

响应消息

  • 正常响应要素说明
    表7 参数说明

    参数

    参数类型

    描述

    id

    String

    参数解释:

    模板ID。

    取值范围:

    不涉及。

  • 正常响应样例
    { 
      "id" : "569d69c2-53e5-4bef-a356-d7ea2ff6fa01" 
    }

状态码

错误码

请参见错误码

相关文档