CancelScheduleEvents--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

CancelScheduleEvents

最近更新时间：2025.03.31 16:59:51首次发布时间：2024.06.27 10:50:53

调用 CancelScheduleEvents 接口取消待执行的计划内事件。

请求类型

同步请求。

注意事项

仅支持取消事件类型为配置变更（ModifyDBInstanceSpec）或修改参数（ModifyClusterParams），事件状态为待执行（pending）的计划内事件。
计划内事件在华北2（北京）、华东2（上海） 地域为邀测功能，如需使用，请提交工单联系技术支持。

请求参数

名称	类型	是否必选	示例值	描述
EventId	Array of String	是	["uo7bx101rr291mgi"]	事件 ID，多个事件 ID 之间使用英文逗号（,）分隔。说明最多支持批量取消 100 个事件。您可调用 DescribeScheduleEvents 接口，查询当前账号下待执行的计划内事件。
InstanceIds	Array of String	是	["vedbm-ca12cbqv****"]	需要取消的事件所属的实例 ID，多个实例 ID 间用英文逗号（,）分隔。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有实例的基本信息，包括实例 ID。

返回参数

无

请求示例

POST /?Action=CancelScheduleEvents&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20240313T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20240313/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "EventId": [
        "4y9aykcszmvp****"
    ],
    "InstanceIds": [
        "vedbm-ezjirvlg****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202403131434528FB0FDB8B15BA21518E4-105733",
        "Action": "CancelScheduleEvents",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

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