ModifyTask--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyTask

最近更新时间：2025.01.22 12:04:49首次发布时间：2024.02.06 22:31:00

调用 ModifyTask 接口编辑任务。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-603e30e6****	实例 ID。
TaskId	String	是	20231025212656894676D90A825E31****	要调整的任务的 ID。
TaskEventOperation	String	是	ChangeToSpecifiedTime	修改任务的修改类型。取值： `ChangeToSpecifiedTime`：修改为指定时间段执行。 `ChangeToMaintainTime`：修改为可维护时间段执行。 `Cancel`：取消任务。 `ImmediateExecute`：立即执行。 `ImmediateSwitch`：立即切换。说明取值为 `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.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.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": {}
}

错误码

更多详情，请参见错误码。