You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeSystemEvents

最近更新时间：2024.02.28 15:03:40

首次发布时间：2022.11.03 08:26:22

我的收藏

调用 DescribeSystemEvents 接口查询实例的系统事件信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是DescribeSystemEvents要执行的操作，取值：DescribeSystemEvents
VersionString是2020-04-01API的版本，取值： 2020-04-01。

EventIds.N

String

否

EventIds.1=e-3ti9101aju3vj0******

事件ID，最多支持100个ID。您可以通过事件通知或调用本接口查询获取。

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

ResourceIds.N

String

否

ResourceIds.1=i-3ti9101aju3vj0******

资源ID，最多支持100个ID。您可以调用DescribeInstances接口，查询获取实例ID。

  • 参数 - N：表示资源的序号。
  • 多个资源ID之间用&分隔。

当前支持的资源类型为ECS实例。

Types.N

String

否

Types.1=SystemFailure_Reboot&Types.2=DiskError_Redeploy

系统事件的类型，最多支持100个。

  • 参数 - N：表示事件类型的序号。
  • 多个事件类型之间用&分隔。
  • 取值：
    • SystemFailure_Stop：系统故障，导致实例停止
    • SystemFailure_Reboot：因系统错误实例重启
    • SystemMaintenance_Redeploy：系统维护，实例重新部署
    • GpuError_Redeploy：GPU异常，导致实例重新部署
    • SystemFailure_Redeploy：系统故障，导致实例重新部署
    • CreateInstance：创建实例
    • RunInstance：启动实例
    • StopInstance：停止实例
    • DeleteInstance：删除实例
    • SpotInstanceInterruption_Delete：抢占型实例中断，实例释放
    • AccountUnbalanced_Stop：账户欠费，实例停止
    • AccountUnbalanced_Delete：账户欠费，实例释放
    • InstanceChargeType_Change：实例计费类型改变
    • InstanceConfiguration_Change：实例配置变更
    • FileSystemReadOnly_Change：文件系统变为只读状态
    • RebootInstance：实例重启
    • InstanceFailure：实例异常
    • ApplicationFailure：应用异常
    • DeploymentSet_Modify：修改实例部署集
    • ServerMigrationTask：服务器迁移任务
    • ServerMigration_FirstSync：服务器迁移，全量数据同步
    • ServerMigration_AdditionalSync：服务器迁移，增量数据同步
    • GpuRiskDetected：GPU运行存在风险
    • InfrastructureUpgrade_Redeploy：基础设施升级，实例重新部署
    • DiskErrorDetected：硬盘异常
    • DiskError_ReplaceDisk：硬盘异常，更换硬盘
    • DiskError_Redeploy：因硬盘故障实例重新部署
    • InstanceOOM：实例内存OOM

Status.N

String

否

Status.1=Executing&Status.2=Inquiring

系统事件的状态，最多支持10个。

  • 参数 - N：表示状态的序号。
  • 多个状态之间用&分隔。
  • 取值：
    • Inquiring：待响应
    • Executing：执行中
    • Succeeded：执行成功
    • Failed：执行失败
    • Scheduled：计划执行
    • Rejected：用户拒绝执行
    • Canceled：已取消
    • Pending：已暂停
    • Recovered：已恢复

Category

String

否

ResourceEvent

事件类别。取值：

  • ResourceEvent：资源事件
  • TaskEvent：任务事件
CreatedAtStartString否2021-06-28T18:29:38+08:00以CreatedAtStart为起点，筛选创建时间在其之后的事件。默认值为CreatedAtEnd前24小时（参考请求参数CreatedAtEnd），格式为RFC3339。
CreatedAtEndString否2021-06-29T18:11:46+08:00以CreatedAtEnd为终点，筛选创建时间在其之前的事件。默认值为现在，格式为RFC3339。
NextTokenString否-分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

否

20

分页查询时设置的每页行数：

  • 最大值：100
  • 默认值：20

返回数据

名称类型示例值描述
NextTokenStringbHpwdXJja2RxemU1eG5sb3NzdGcW1-RC******本次调用返回的查询凭证值，返回为空表示该页为末页。
SystemEventsArray of struct-实例系统事件信息。具体请参见下表“SystemEvents 结构”。

SystemEvents 结构

名称类型示例值描述
IdStringe-3tiegs1y963vj0******系统事件ID。
CreatedAtString2021-06-29T18:11:46+08:00系统事件创建时间。
UpdatedAtString2021-06-29T18:11:46+08:00系统事件更新时间。
CategoryStringResourceEvent事件类别。
TypeStringSystemFailure_Stop系统事件的类型。
StatusStringExecting系统事件的状态。
ResourceIdStringi-3tiegs1y963vj0******资源ID。
OperatedStartAtString2022-08-30T15:11:46+08:00运维时间窗口的起始时间。
OperatedEndAtString2022-09-10T18:11:46+08:00运维时间窗口结束时间。
ExtraInfoStruct{"VolumeId": "vol-3tiegs1y963vj***","DeviceName": "/dev/sda"}系统事件的扩展信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeSystemEvents",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "SystemEvents": [
            {
                "Id": "e-3ti9101aju3vj0******",
                "Category": "ResourceEvent",
                "CreatedAt": "2022-06-15T16:34:34+08:00",
                "UpdatedAt": "2022-06-15T16:34:49+08:00",
                "ResourceId": "i-3ti9101aju3vj0******",
                "Type": "DiskError_Redeploy",
                "Status": "Succeeded",
                "OperatedStartAt": "2022-08-30T15:11:46+08:00",
                "OperatedEndAt":"2022-09-10T18:11:46+08:00",
                "ExtraInfo": {
                    "DeviceName": "/dev/sda",
                    "VolumeId": "vol-3tiegs1y963vj0******"
                }
            }
        ],
        "NextToken": ""
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidCategory.MalformedThe specified Category is malformed.指定的Category不合法。
400LimitExceeded.MaximumEventIdsYou've reached the limit on the number of EventIds that you can set.指定的事件ID数量超过限制。
400LimitExceeded.MaximumResourceIdsYou've reached the limit on the number of ResourceIds that you can set.指定的资源ID数量超过限制。
400LimitExceeded.MaximumStatusYou've reached the limit on the number of Status that you can set.指定的事件状态数量超过限制。
400LimitExceeded.MaximumTypesYou've reached the limit on the number of Types that you can set.指定的事件类型数量超过限制。
400InvalidCreatedAtStart.MalformedThe specified CreatedAtStart is malformed.CreatedAtStart格式不正确，应符合RFC3339。
400InvalidCreatedAtEnd.MalformedThe specified CreatedAtEnd is malformed.CreatedAtEnd格式不正确，应符合RFC3339。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumMaxResultsThe number of specified MaxResults exceeds the maximum limit.指定的MaxResults超过最大限制。
400LimitExceeded.MinimumMaxResultsThe number of specified MaxResults exceeds the minimum limit.指定的MaxResults超过最小限制。
400InvalidTypes.MalformedThe specified Types is malformed.指定的Types不合法。
400InvalidStatus.MalformedThe specified Status is malformed.指定的Status不合法。
400InvalidEventIds.MalformedThe specified EventIds is malformed.指定的EventIds不合法。
400InvalidResourceIds.MalformedThe specified ResourceIds is malformed.指定的ResourceIds不合法。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。