DescribePlannedEvents--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribePlannedEvents

最近更新时间：2025.03.20 10:44:46首次发布时间：2025.03.20 10:44:46

调用 DescribePlannedEvents 接口查询目标 Redis 实例在指定时间段的计划内事件。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
PageNumber	Integer	是	1	计划内事件列表的页码。取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	是	10	每页记录数。取值为 1~100 间的整数。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。模糊查询。说明若该参数留空，表示不使用实例 ID 条件进行筛选。您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
MinStartTime	String	否	2025-02-26T19:00:00Z	需要查询的计划内事件的最早执行时间。格式为 `yyyy-MM-ddTHH:mm:ssZ` （UTC）。说明若该参数留空，表示不使用最早计划执行时间进行筛选。
MaxStartTime	String	否	2025-02-26T19:01:00Z	需要查询的计划内事件的最晚执行时间。格式为 `yyyy-MM-ddTHH:mm:ssZ` （UTC）。说明若该参数留空，表示不使用最晚计划执行时间进行筛选。查询结束时间需晚于开始时间。

返回参数

参数	类型	示例值	描述
PlannedEvents	Object[]		计划内事件信息列表。
Total	Integer	1	计划内事件的总数。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribePlannedEvents&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "PageNumber": 1,
    "PageSize": 10,
    "InstanceId": "redis-cn0212gzmh2xs****",
    "MinStartTime": "2025-02-26T19:00:00Z",
    "MaxStartTime": "2025-02-26T19:01:00Z"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "DescribePlannedEvents",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "PlannedEvents": [
            {
                "ActionName": "升级内核版本",
                "CanCancel": false,
                "CanModifyTime": false,
                "EventId": "event-cn0212gzmh2xs****",
                "InstanceId": "redis-cn0212gzmh2xs****",
                "InstanceName": "test",
                "MaxEndTime": "",
                "PlanEndTime": "2025-02-26T19:59:59Z",
                "PlanStartTime": "2025-02-26T19:00:00Z",
                "Status": "Waiting",
                "Type": "SystemMaintenance"
            }
        ],
        "Total": 1
    }
}

错误码

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