You need to enable JavaScript to run this app.
导航

DescribeEventTypes

最近更新时间2024.01.15 14:34:17

首次发布时间2023.05.09 08:20:32

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

调试

请求参数

名称类型必填示例值描述
ActionStringDescribeEventTypes要执行的操作,取值:DescribeEventTypes。
VersionString2020-04-01API的版本,取值: 2020-04-01。

Types.N

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(默认):不需要响应
NextTokenString3tiegs1y963vj0******分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

20

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

  • 最大值:100
  • 默认值:100

返回数据

字段类型示例值说明
NextTokenString3tiegs1y963vj0******本次调用返回的查询凭证值,返回为空表示该页为末页。
EventTypesArray of struct-实例系统事件信息。具体请参见下表“EventTypes 结构”。

EventTypes 结构

名称类型示例值描述
TypeStringDiskError_Redeploy系统事件的类型。
KindStringUnexpectedOperations系统事件的类别。
StatusList["Executing", "Succeeded", "Failed"]系统事件的状态。
ResponseRequiredBooleanfalse是否需要响应。
TitleString硬盘异常,实例重新部署系统事件的中文描述。

请求示例

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": ""
  }
}

错误码

HttpCode错误码错误信息描述
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumTypesYou've reached the limit on the number of Types that you can set.指定的类型数量超过限制。
400InvalidKind.MalformedThe specified Kind is malformed.指定的Kind不合法。
400InvalidTypes.MalformedThe specified Types is malformed.指定的Types不合法。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。