# 查询数据库定时任务策略模板列表 - ListJobSchedules #### 功能介绍 查询数据库定时任务策略模板列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListJobSchedules)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds::listDbJobSchedules | read | - | - | rds::listDbJobSchedules | - | #### URI - URI格式 GET /v3/{project_id}/db-job/schedules - 参数说明 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | schedule_type | 否 | String | **参数解释：** 策略类型。 **约束限制：** 不涉及。 **取值范围：** - snapshot：快照策略。 - sync：同步策略。 **默认取值** **：** 默认查询所有类型。 | | schedule_id | 否 | String | **参数解释：** 策略ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值** **：** 10 | #### 请求示例 查询定时任务模板列表 ``` GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/db-job/schedules?schedule_type=snapshot ``` #### 响应消息 - 正常响应要素说明 表3参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | schedules | Array of objects | **参数解释：** 策略列表。 详见[表4]。 | | total_count | Integer | **参数解释：** 策略总数。 **取值范围：** 不涉及。 | 表4schedules元素结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 策略ID。 **取值范围：** 仅支持OBS或BACKUP。 | | user_defined | Boolean | **参数解释：** 是否是用户自定义模板。 **取值范围：** - false：表示为系统默认模板。 - true：表示为用户自定义模板。 | | schedule_type | String | **参数解释：** 策略类型。 **取值范围：** - snapshot：快照策略。 - sync：同步策略。 | | job_schedule_type | String | **参数解释：** 计划类型。 **取值范围：** - automatically：SQL Server代理启动时自动启动。 - cpu_idle：CPU空闲时启动。 - recurring：重复执行。 - one_time：执行一次。 | | one_time_occurrence | Object | **参数解释：** 执行一次执行时间。 详情请参见[表5]。 | | frequency | Object | **参数解释：** 策略间隔周期。仅当策略ID为空时生效。 详情请参见[表6]。 | | daily_frequency | Object | **参数解释：** 策略每日频率。仅当策略ID为空时生效。 详情请参见[表7]。 | | duration | Object | **参数解释：** 策略有效期。仅当策略ID为空时生效。 详情请参见[表8]。 | 表5one_time_occurrence元素结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | active_start_date | String | **参数解释：** 执行日期，格式：yyyy-MM-dd。 **取值范围：** 1990-01-01\~2099-12-31 | | active_start_time | String | **参数解释：** 执行时间，格式：HH:mm:ss。 **取值范围：** 不涉及。 | 表6frequency元素结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | 表7daily_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：时。 | 表8duration元素结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | active_start_date | String | **参数解释：** 第一次执行日期，格式：yyyy-MM-dd。 **取值范围：** 1990-01-01\~2099-12-31 | | active_end_date | String | **参数解释：** 最后一次执行日期，默认不会结束，格式：yyyy-MM-dd。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "schedules" : [ { "id" : "569d69c2-53e5-4bef-a356-d7ea2ff6fa01", "user_defined" : false, "schedule_type" : "snapshot", "frequency" : { "freq_type" : "daily", "freq_interval" : 1 }, "daily_frequency" : { "freq_subday_type" : "multiple", "active_start_time" : "00:00:00", "active_end_time" : "23:59:59", "freq_subday_interval" : 1, "freq_interval_unit" : "minute" }, "duration" : { "active_start_date" : "1990-01-01", "active_end_date" : "2099-12-31" } }, { "id" : "569d69c2-53e5-4bef-a356-d7ea2ff6fa04", "user_defined" : false, "schedule_type" : "snapshot", "frequency" : { "freq_type" : "weekly", "freq_interval" : 1, "freq_interval_weekly" : [ "Sunday" ] }, "daily_frequency" : { "freq_subday_type" : "once", "active_start_time" : "02:00:00" }, "duration" : { "active_start_date" : "1990-01-01", "active_end_date" : "2099-12-31" } }, { "id" : "569d69c2-53e5-4bef-a356-d7ea2ff6fa01", "user_defined" : false, "schedule_type" : "snapshot", "frequency" : { "freq_type" : "monthly_day", "freq_interval" : 1, "freq_interval_day_monthly" : 1 }, "daily_frequency" : { "freq_subday_type" : "once", "active_start_time" : "02:00:00" }, "duration" : { "active_start_date" : "1990-01-01", "active_end_date" : "2099-12-31" } }, { "id" : "569d69c2-53e5-4bef-a356-d7ea2ff6fa01", "user_defined" : false, "schedule_type" : "snapshot", "frequency" : { "freq_type" : "monthly_week", "freq_interval" : 1, "freq_interval_monthly" : "Sunday", "freq_relative_interval_monthly" : "first" }, "daily_frequency" : { "freq_subday_type" : "once", "active_start_time" : "02:00:00" }, "duration" : { "active_start_date" : "1990-01-01", "active_end_date" : "2099-12-31" } } ], "total_count" : 4 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。