DescribeEventTypes - 查询系统事件类型列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeEventTypes - 查询系统事件类型列表

最近更新时间：2024.05.21 10:26:16首次发布时间：2023.05.09 08:20:32

调用 DescribeEventTypes 接口，查询事件类型列表。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeEventTypes	要执行的操作，取值：DescribeEventTypes。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
Types.N	Array of String	否	Types.1=DiskError_Redeploy&Types.2=CreateInstance	系统事件的类型，最多支持100个。参数 - N：表示事件类型的序号多个事件类型之间用`&`分隔取值： UnknownType：未知类型 SystemFailure_Stop：系统故障，导致实例停止 SystemFailure_Reboot：系统故障，导致实例重启 SystemFailure_PleaseCheck：系统故障，请检查实例 GpuError_Redeploy：GPU异常，导致实例重新部署 SystemMaintenance_Redeploy：系统维护，实例重新部署 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
Kind	String	否	StateChange	系统事件的类别。取值： UnexpectedOperations：非预期运维事件 PlannedOperations：计划运维事件 StateChange：状态变化事件 BalanceWarning：费用预警事件 TaskStatus：任务状态类事件
ResponseRequired	Boolean	否	false	是否需要响应。取值： true：需要响应 false（默认）：不需要响应
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	20	分页查询时设置的每页行数。最大值：100 默认值：100

返回参数

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

参数	类型	示例值	描述
EventTypes	Array of EventTypesForDescribeEventTypes	--	实例系统事件信息。
NextToken	String	3tiegs1y963vj0******	本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeEventTypes&Version=2020-04-01&Types.1=DiskError_Redeploy&Types.2=CreateInstance HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202106111445100102252431000052****",
    "Action": "DescribeEventTypes",
    "Version": "2020-04-01",
    "Service": "ecs",
    "Region": "cn-beijing"
  },
  "Result": {
    "EventTypes": [
      {
        "Type": "DiskError_Redeploy",
        "Kind": "UnexpectedOperations",
        "Status": [
          "Executing",
          "Succeeded",
          "Failed"
        ],
        "ResponseRequired": "true",
        "Title": "硬盘异常，实例重新部署"
      },
      {
        "Type": "CreateInstance",
        "Kind": "StateChange",
        "Status": [
          "Executing",
          "Succeeded",
          "Failed"
        ],
        "ResponseRequired": "false",
        "Title": "创建实例"
      }
    ],
    "NextToken": ""
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	LimitExceeded.MaximumTypes	You've reached the limit on the number of Types that you can set.	指定的类型数量超过限制。
400	InvalidTypes.Malformed	The specified Types is malformed.	指定的Types不合法。
400	InvalidKind.Malformed	The specified Kind is malformed.	指定的Kind不合法。
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。