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

文档中心

立即注册

导航

DescribeScheduleEvents

最近更新时间：2025.03.31 17:06:21首次发布时间：2024.06.27 10:50:53

调用 DescribeScheduleEvents 接口查看当前账号下的计划内事件。

请求类型

同步请求。

注意事项

计划内事件在华北2（北京）、华东2（上海） 地域为邀测功能，如需使用，请提交工单联系技术支持。

请求参数

名称	类型	是否必选	示例值	描述
Limit	Integer	否	10	每页记录数。最小值为 1，最大值不超过 500。默认值为 10。
Offset	Integer	否	0	当前页查询偏移量，取值最小为 0。默认值为 0。
EventId	String	否	4nbx88ea9dxa****	事件 ID。
InstanceId	String	否	vedbm-ca12cbqv****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 veDB MySQL 实例的基本信息，包括实例 ID。
BeginTime	String	否	2024-03-13T03:07:19Z	事件开始执行时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
EndTime	String	否	2024-03-13T03:07:19Z	事件执行结束时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
Status	Array of String	否	pending	事件状态。取值： `pending`：待执行。 `executing`：执行中。 `failure`：执行失败。 `finish`：已完成。 `cancel`：已取消。
EventKind	Array of String	否	ModifyDBInstanceSpec	事件类型。取值： `ModifyClusterParams`：修改参数。 `ModifyDBInstanceSpec`：配置变更。 `UpgradeInstance`：版本升级。
ProjectName	String	否	default	事件对应实例所属的项目名称。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。

返回参数

名称	类型	示例值	描述
ScheduleTasksInfo	Array of ScheduleTasksInfoObject	请参见返回示例。	事件详情信息。关于 ScheduleTasksInfo 的详情信息，请参见 ScheduleTasksInfoObject。
Total	Integer	2	事件总数。

请求示例

POST /?Action=DescribeScheduleEvents&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****

{
    "Limit": 20,
    "Offset": 0,
    "Status": [
        "pending"
    ],
    "EventKind": [
        "ModifyClusterParams"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031314111883597BAC11B7B598****-72c862",
        "Action": "DescribeScheduleEvents",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScheduleTasksInfo": [
            {
                "AccountID": 2100069027,
                "EventId": "y61wnejqtyga****",
                "EventKind": "ModifyClusterParams",
                "InstanceID": "vedbm-jnfxn2lf****",
                "InstanceName": "test_az",
                "Message": "",
                "PlannedStartTime": "2024-03-13T10:00:00Z",
                "ProjectName": "default",
                "RequestId": "",
                "ScheduleType": "MaintainTime",
                "Status": "pending"
            },
            {
                "AccountID": 2100069027,
                "EventId": "4gjplaoge55f****",
                "EventKind": "ModifyClusterParams",
                "InstanceID": "vedbm-osh2b3tf****",
                "InstanceName": "test_lm",
                "Message": "",
                "PlannedStartTime": "2024-03-13T17:00:00Z",
                "ProjectName": "default",
                "RequestId": "",
                "ScheduleType": "MaintainTime",
                "Status": "pending"
            }
        ],
        "Total": 2
    }
}

错误码

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