调用 UpdateSystemEvents 接口,修改系统事件状态。
SystemMaintenance.Redeploy
(系统维护,实例重新部署)事件授权时,支持使用OperatedStartAt
、OperatedEndAt
参数调整运维时间窗。OperatedStartAt
、 OperatedEndAt
参数仅支持传入如下时间段:
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
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接口查询获取。
|
OperatedEndAt | String | 否 | 2022-09-02T15:11:46+08:00 | 事件运维时间窗结束时间,默认是收到请求的时间+72小时,格式为RCF3339。 说明 暂仅 |
OperatedStartAt | String | 否 | 2022-08-30T15:11:46+08:00 | 事件运维时间窗开始时间,默认是收到请求的时间+60小时,格式为RCF3339。 说明 仅 |
Status | String | 是 | Executing | 系统事件的状态,取值:
|
UpdatedAt | String | 否 | 2021-06-28T18:29:38+08:00 | 事件更新的时间,默认是收到请求的时间,格式为RFC3339。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
说明
仅当请求参数输入不合法时提示下文中的接口错误码。当请求参数输入无误时,接口返回状态码为200
且不会返回接口错误码,但这并不代表对系统事件的操作均已成功,单个系统事件的操作结果请参见如下返回参数中的信息。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
OperationDetails | Array of Object | -- | 操作详情。 |
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 | InvalidOperatedEndAt.Malformed | 指定的OperatedEndAt不合法。 |
400 | InvalidOperatedStartAt.Malformed | 指定的OperatedStartAt不合法。 |
400 | InvalidStatus.Malformed | 指定的Status不合法。 |
400 | InvalidSystemEventStatus.PreStatusMismatch | 指定的系统事件与状态不匹配。 |
400 | InvalidSystemEventStatus.TypeMismatch | 指定的系统事件类型与状态不匹配。 |
400 | InvalidUpdatedAt.Malformed | 指定的UpdatedAt不正确。 |
400 | LimitExceeded.MaximumEventIds | 指定的事件ID数量超过限制。 |
400 | MissingParameter.EventIds | 缺失事件ID。 |
400 | MissingParameter.Status | 参数Status不能为空。 |
404 | InvalidActionOrVersion | 请求接口不存在。 |
500 | InternalError | 内部错误,请重试。如果多次尝试失败,请提交工单。 |