DescribePlannedEvents--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribePlannedEvents

最近更新时间：2025.04.23 14:22:49首次发布时间：2025.04.23 14:22:49

调用 DescribePlannedEvents 接口查询当前地域下的运维事件。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceName	String	否	测试实例	实例名称。
InstanceId	String	否	postgres-a2f9831f****	实例 ID。
EventId	String	否	61c7adeb0f49426ab032cb8cf1e2****	事件 ID。
EventType	String[]	否	["VersionUpgrade"]	事件类型。取值范围（可取多个值）： `VersionUpgrade`：版本升级。 `HostOffline`：主机下线。
Status	String[]	否	["WaitStart"]	运维事件的状态。取值范围（可取多个值）： `Canceled`：已取消。 `WaitStart`：待执行。 `WaitSwitch`：待切换。 `Running`：运行中。 `Running_BeforeSwitch`：运行中-切换前。 `Running_Switching`：运行中-切换中。 `Running_AfterSwitch`：运行中-切换后。 `Success`：成功。 `Failed`：失败。 `Timeout`：超时。 `Rollbacking`：回滚中。 `RollbackFailed`：回滚失败。
PlannedBeginTimeSearchRangeStart	String	否	2025-09-01T02:06:53.000Z	按照“计划执行时间”查询事件时的时间区间的起点。格式：`yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。
PlannedBeginTimeSearchRangeEnd	String	否	2025-09-01T17:40:53.000Z	按照“计划执行时间”查询事件时的时间区间的终点。格式：`yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。说明 PlannedBeginTimeSearchRangeEnd 应晚于 PlannedBeginTimeSearchRangeStart。 PlannedBeginTimeSearchRangeStart 与 PlannedBeginTimeSearchRangeEnd 定义了一个时间段。当事件满足，其“计划执行时间”落入该时间段范围内时，该事件将被检索命中并返回。
PlannedSwitchTimeSearchRangeStart	String	否	2025-09-01T18:17:28.000Z	按照“计划切换时间”查询事件时的时间区间的起点。格式：`yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。
PlannedSwitchTimeSearchRangeEnd	String	否	2025-09-01T18:47:28.000Z	按照“计划切换时间”查询事件时的时间区间的终点。格式：`yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。 PlannedSwitchTimeSearchRangeStart 与 PlannedSwitchTimeSearchRangeEnd 定义了一个时间段。当事件的“计划切换时间段”与该时间段范围有重叠时，该事件将被返回。
PageNumber	Integer	否	2	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	20	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	4	运维事件总数。
PlannedEvents	Object[]	请参见返回示例。	当前地域内在当前查询条件下的运维事件列表。

示例

请求示例

POST /?Action=DescribePlannedEvents&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025031921035852D25471A9CB03E58270-2c52e4",
        "Action": "DescribePlannedEvents",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "PlannedEvents": [
            {
                "BusinessImpact": "切换过程会可能有秒级连接闪断，建议程序设置自动重试重连机制以避免事件影响。",
                "EventID": "01ba7dca897b46b5b352cba1e286b1c8",
                "EventType": "VersionUpgrade",
                "InstanceId": "postgres-fdc70683****",
                "InstanceName": "",
                "PlannedBeginTime": "2025-09-01T18:06:53.000Z",
                "PlannedEventReason": "实例版本例行升级迭代, 修复已知问题和发布新特性。",
                "PlannedSwitchBeginTime": "2025-09-01T18:17:28.000Z",
                "PlannedSwitchEndTime": "2025-09-01T18:47:28.000Z",
                "Region": "cn-beijing",
                "Status": "WaitStart"
            },
            {
                "BusinessImpact": "切换过程会可能有秒级连接闪断，建议程序设置自动重试重连机制以避免事件影响。",
                "EventID": "2420468b1ddd4a1782d2dc3e2945f107",
                "EventType": "VersionUpgrade",
                "InstanceId": "postgres-09631f39****",
                "InstanceName": "",
                "PlannedBeginTime": "2025-09-01T18:04:48.000Z",
                "PlannedEventReason": "实例版本例行升级迭代, 修复已知问题和发布新特性。",
                "PlannedSwitchBeginTime": "2025-09-01T18:13:12.000Z",
                "PlannedSwitchEndTime": "2025-09-01T18:43:12.000Z",
                "Region": "cn-beijing",
                "Status": "WaitStart"
            }
        ],
        "Total": 2
    }
}