云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）任务管理ModifyTask - 编辑任务
复制全文
下载 pdfModifyTask - 编辑任务
文档反馈
问问助手调用 ModifyTask 接口编辑任务。
请求类型
同步请求。
注意事项
发起以下任务并选择在指定时间段或可运维时间段执行时，任务会进入等待执行状态。任务的取消可立即生效。
- RestartDBInstance
- ModifyDBProxySpec
发起以下任务并选择在指定时间段或可运维时间段执行时，任务会进入运行中（切换前） 状态，进行操作相应的资源准备和后台调度工作。如在此期间取消任务，取消会在当前阶段（资源准备和后台调度）完成后，再执行取消。
- MigrateToOtherZone
- UpgradeDBInstanceEngineMinorVersion
- CreateDBNodes
- DeleteDBNodes
- ModifyDBNodeSpec
- ModifyDBNodeTemporarySpec
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | mysql-603e30e6**** | 实例 ID。 |
TaskId | String | 是 | 20231025212656894676D90A825E31**** | 要调整的任务的 ID。 |
TaskEventOperation | String | 是 | ChangeToSpecifiedTime | 修改任务的修改类型。取值：
说明 取值为 ChangeToSpecifiedTime 时，需要指定 ModifyBeginTime 和 ModifyEndTime。 |
ModifyBeginTime | String | 否 | 2024-12-22T05:00:00Z | 指定时间段执行时时间段的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 指定任务的执行方式为指定时间执行时，即 TaskEventOperation 取值为ChangeToSpecifiedTime时，必填。 |
ModifyEndTime | String | 否 | 2024-12-22T06:59:00Z | 指定时间段执行时时间段的结束时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明 指定任务的执行方式为指定时间执行时，即 TaskEventOperation 取值为ChangeToSpecifiedTime时，必填。 |
ProjectName | String | 否 | default | 所属的项目。 说明 如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。 |
返回参数
null
示例
请求示例 1
取消任务
POST /?Action=ModifyTask&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"InstanceId": "mysql-f2f3bd1f****",
"TaskId": "20240122071944PSCANNER0324C2****-7f2ca6",
"TaskEventOperation": "Cancel"
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "2023081115435093486CC3E10539843CDA",
"Action": "ModifyTask",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {}
}
请求示例 2
修改任务执行时间
POST /?Action=ModifyTask&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"InstanceID": "mysql-f2f3bd1f****",
"TaskId": "2024122415200733A28F43CA1D6B6CF4AF-1454a2",
"TaskEventOperation": "ChangeToSpecifiedTime",
"ModifyBeginTime": "2024-12-27T09:00:00Z",
"ModifyEndTime": "2024-12-28T09:00:00Z"
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "202412241523281F4B96DE5383EB6F8F43-13bdf4",
"Action": "ModifyTask",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {}
}
错误码
最近更新时间：2026.04.09 11:58:30
这个页面对您有帮助吗？
有用
有用
无用
无用