创建一个新的批量实例定时巡检配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rdsai:CreateScheduledTask | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 是 | 定时巡检任务名称(不超过 64 字符)。 | RDS巡检 |
| Description | string | 否 | 定时巡检任务描述。 | 定时RDS实例巡检任务 |
| InstanceIds | string | 是 | 关联实例 ID 列表, 多个取值用英文逗号(,)隔开。 | rm-2ze6mk259v322****,rm-2zef3b65430j0**** |
| StartTime | string | 否 | 执行巡检任务的时间。格式:HH:mm:ssZ(UTC 时间)。默认凌晨 2 点。 | 02:00:00Z |
| Frequency | string | 否 | Monday | |
| TimeRange | string | 否 | 巡检时间范围,默认最近 24 小时,取值:1~168(最大支持 7 天)。 | 24 |
返回参数
示例
正常返回示例
JSON格式
{
"ScheduledId": "847268a4-196f-416b-aa12-bfe0c115****",
"Success": true,
"Message": "创建定时巡检任务成功",
"RequestId": "D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | Request parameter validation failed. | 请求参数校验失败 |
| 403 | PermissionDenied | User has no operation permission. | 用户无操作权限 |
| 403 | InvalidUserOrder | There is no valid order for this UID. | 该UID并没有有效订单 |
| 404 | TaskNotFound | The resource of the specified ld does not exist. | 指定ld的资源不存在 |
| 500 | InternalError | System internal exception. | 系统内部异常 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-02-05 | 新增 OpenAPI | 查看变更详情 |
