授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|
dms:instance:modifyScheduledTask | Write | kafka | g:ResourceTag/<tag-key> g:EnterpriseProjectId
| dms:instance:modify | - |
rabbitmq | g:ResourceTag/<tag-key> g:EnterpriseProjectId
|
rocketmq | g:ResourceTag/<tag-key> g:EnterpriseProjectId
|
URI
PUT /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}
表1 路径参数 参数 | 是否必选 | 参数类型 | 描述 |
|---|
project_id | 是 | String | 参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
instance_id | 是 | String | 参数解释： 实例ID。获取方法如下：调用查询所有实例列表接口，从响应体中获取实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
task_id | 是 | String | 参数解释： 定时任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
表2 Query参数 参数 | 是否必选 | 参数类型 | 描述 |
|---|
execute_at | 否 | String | 参数解释： 修改定时任务的执行时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
status | 否 | String | 参数解释： 修改定时任务状态。 约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
请求示例
将指定定时任务的执行时间修改为20240101000000
/v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}?execute_at=20240101000000取消指定的定时任务。
/v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}?status=CANCELLED
