You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

DescribePlannedEvents

最近更新时间：2024.04.02 11:06:59

首次发布时间：2023.08.14 13:16:21

我的收藏

调用 DescribePlannedEvents 接口查询计划内事件的列表信息。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString否mysql-d4942fd7****实例 ID。
BeginTimeString否2023-08-03T06:25:22Z事件发生开始时间。格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。
EndTimeString否2023-08-12T06:25:34Z事件发生开始时间。格式为 yyyy-MM-dd HH:mm:ss（UTC 时间）。
EventIdString否df078de739d3412aa430905bcd13****事件 ID。

EventType

Array of String

否

["VersionUpgrade"]

事件种类。取值：

  • VersionUpgrade：版本升级。
  • SSLCertificateUpdate：SSL 证书更新。
  • HostOffline：主机下线。

Status

Array of String

否

["Waiting"]

事件状态。取值范围如下（可取多个值）：

  • Initiated：已发起。
  • Canceled：已取消。
  • Waiting：待执行。
  • Succeed：成功。
  • Failed：失败。

返回参数

名称类型示例值描述
TotalInteger3计划内事件总数。
PlannedEventsArray of PlannedEventObject请参见返回示例。计划内事件信息。关于 PlannedEvent 的更多信息，请参见数据结构。

请求示例

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

{
    "StartTime":"2024-01-08T06:00:00Z",
    "EndTime":"2024-01-15T06:00:00Z"
}

返回示例

正常返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "20230810145403789088F993D213731417",
        "Action": "DescribePlannedEvents",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "PlannedEvents": [
            {
                "BusinessImpact":"火山引擎数据库控制台实例列表页面会有短暂的状态展示延迟，不影响数据库使用",
                "DBEngine":"MySQL",
                "EventAction":"UpgradeResource",
                "EventID":"d64eda8b7f47414e95a4e46540320b70",
                "InstanceId":"mysql-5564bc65****",
                "InstanceName":"测试实例",
                "IsUrgent": true,
                "MaxDelayTime":"2024-02-02T15:10:00Z",
                "OriginBeginTime": "2024-01-02T15:10:00Z",
                "PlannedBeginTime":"2024-01-02T15:10:00Z",
                "PlannedEndTime":"2024-01-02T15:59:00Z",
                "PlannedEventDescription": "upgrade instance to 2.10.2.28",
                "PlannedEventReason": "instance version upgrade",
                "Region":"cn-beijing",
                "Status": "Initiated"
            }
        ],
        "Total": 1
    }
}

错误码

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