You need to enable JavaScript to run this app.
导航
UpdateSystemEvents - 修改系统事件状态
最近更新时间:2024.05.21 10:26:16首次发布时间:2022.11.03 08:26:23

调用 UpdateSystemEvents 接口,修改系统事件状态。

请求说明

  • SystemMaintenance.Redeploy(系统维护,实例重新部署)事件授权时,支持使用OperatedStartAtOperatedEndAt参数调整运维时间窗。
  • OperatedStartAt、 OperatedEndAt 参数仅支持传入如下时间段:
    • 事件发生时间 ~ 事件发生时间+12h
    • 事件发生时间+12h ~ 事件发生时间+24h
    • 事件发生时间+24h ~ 事件发生时间+36h
    • 事件发生时间+36h ~ 事件发生时间+48h
    • 事件发生时间+48h ~ 事件发生时间+60h
    • 事件发生时间+60h ~ 事件发生时间+72h

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

UpdateSystemEvents

要执行的操作,取值:UpdateSystemEvents。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

EventIds.N
Array of String

EventIds.1=e-3ti9101aju3vj0****&EventIds.2=e-3tiegs1y963vj0****

事件ID,最多支持100个ID。您可以通过事件通知DescribeSystemEvents接口查询获取。

  • 参数 - N:表示事件ID的序号。
  • 多个事件ID之间用&分隔。
OperatedEndAt
String

2022-09-02T15:11:46+08:00

事件运维时间窗结束时间,默认是收到请求的时间+72小时,格式为RCF3339。

说明

暂仅SystemMaintenance.Redeploy(系统维护,实例重新部署)事件可调整运维时间。

OperatedStartAt
String

2022-08-30T15:11:46+08:00

事件运维时间窗开始时间,默认是收到请求的时间+60小时,格式为RCF3339。

说明

SystemMaintenance.Redeploy(系统维护,实例重新部署)事件可调整运维时间。

Status
String

Executing

系统事件的状态,取值:

  • Executing:执行中
UpdatedAt
String

2021-06-28T18:29:38+08:00

事件更新的时间,默认是收到请求的时间,格式为RFC3339。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
OperationDetails
Array of OperationDetailsForUpdateSystemEvents

--

操作详情。

请求示例

GET /?Action=UpdateSystemEvents&Version=2020-04-01&EventIds.1=t-3ti9101aju3vj0******&Status=Executing HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "UpdateSystemEvents",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": [
            {
                "EventId": "e-ybq95rphkoawmb******",
                "Error": {
                    "Code": "InvalidSystemEvent.NotFound",
                    "Message": "The specified system event does not exist."
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidOperatedStartAt.Malformed
The specified OperatedStartAt is malformed.

指定的OperatedStartAt不合法。

400
InvalidOperatedEndAt.Malformed
The specified OperatedEndAt is malformed.

指定的OperatedEndAt不合法。

400
MissingParameter.Status
The required parameter Status is not supplied.

参数Status不能为空。

400
MissingParameter.EventIds
The required parameter EventIds is not supplied.

缺失事件ID。

400
LimitExceeded.MaximumEventIds
You've reached the limit on the number of EventIds that you can set.

指定的事件ID数量超过限制。

400
InvalidUpdatedAt.Malformed
The specified UpdatedAt is malformed.

指定的UpdatedAt不正确。

400
InvalidSystemEventStatus.TypeMismatch
The specified system event type does not match this status.

指定的系统事件类型与状态不匹配。

400
InvalidSystemEventStatus.PreStatusMismatch
The specified system event does not match pre status.

指定的系统事件与状态不匹配。

400
InvalidStatus.Malformed
The specified Status is malformed.

指定的Status不合法。

404
InvalidActionOrVersion
Could not find operation %s for version %s.

请求接口不存在。

500
InternalError
An internal error has occurred.

内部错误,请重试。如果多次尝试失败,请提交工单。