DescribeEvents - 查询资源事件_云服务器 ECS(ECS)-阿里云帮助中心

查询云盘风险事件。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ebs:DescribeEvents	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查询块存储数据洞察支持的地域列表。	cn-hangzhou
EventName	string	否	事件名称。取值范围： NoSnapshot：数据保护 BurstIOTriggered：突发 IO CostOptimizationNeeded：成本优化 DiskSpecNotMatchedWithInstance：实例与磁盘规格不匹配 DiskIONo4kAligned：非 4K 对齐读写 DiskIOHang：磁盘有 IOHang 发生 InstanceIOPSExceedInstanceMaxLimit：实例 IOPS 到达上限 InstanceBPSExceedInstanceMaxLimit：实例 BPS 到达上限 DiskIOPSExceedInstanceMaxLimit：磁盘 IOPS 到达实例上限 DiskBPSExceedInstanceMaxLimit：磁盘 BPS 到达实例上限 DiskIOPSExceedDiskMaxLimit：磁盘 IOPS 到达磁盘上限 DiskBPSExceedDiskMaxLimit：磁盘 BPS 到达磁盘上限	DiskIOHang
ResourceId	string	否	资源 ID。	d-bp67acfmxazb4p****
ResourceType	string	否	资源类型。取值范围： disk：磁盘	disk
Status	string	否	事件状态。取值范围： WillExecute：待处理 Executing：处理中 Executed：已处理 Ignore：已忽略 Expired：已过期 Deleted：已删除	WillExecute
StartTime	string	否	事件开始时间点。按照 ISO8601 标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-06-01T03:00:00Z
EndTime	string	否	事件结束时间点。按照 ISO8601 标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-06-01T04:00:00Z
MaxResults	integer	否	分页查询时每页的最大条目数。一旦设置该参数，即表示使用`MaxResults`与`NextToken`组合参数的查询方式。取值范围：1~100。默认值：10。	10
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAdDWBF2****
EventLevel	string	否	事件级别，取值说明： INFO：通知 WARN：严重 CRITICAL：告警	WARN

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	分页查询时的结果总条数。	1
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAdDWBF2****
ResourceEvents	array<object>	事件列表。
resourceEvent	object
EventType	string	事件类型。可能值： Notification SystemException Alert	Alert
EventName	string	事件名称。可能值： NoSnapshot：数据保护 BurstIOTriggered：突发 IO CostOptimizationNeeded：成本优化 DiskSpecNotMatchedWithInstance：实例与磁盘规格不匹配 DiskIONo4kAligned：非 4K 对齐读写 DiskIOHang：磁盘有 IOHang 发生 InstanceIOPSExceedInstanceMaxLimit：实例 IOPS 到达上限 InstanceBPSExceedInstanceMaxLimit：实例 BPS 到达上限 DiskIOPSExceedInstanceMaxLimit：磁盘 IOPS 到达实例上限 DiskBPSExceedInstanceMaxLimit：磁盘 BPS 到达实例上限 DiskIOPSExceedDiskMaxLimit：磁盘 IOPS 到达磁盘上限 DiskBPSExceedDiskMaxLimit：磁盘 BPS 到达磁盘上限	DiskIOHang
ResourceId	string	资源 ID。	d-bp67acfmxazb4p****
ResourceType	string	资源类型。	disk
Status	string	事件状态。可能值： WillExecute：待处理 Executing：处理中 Executed：已处理 Ignore：已忽略 Expired：已过期 Deleted：已删除	WillExecute
StartTime	string	事件开始时间戳（毫秒级）。	1684204822000
Description	string	事件描述。	可通过购买4296预配置IOPS以获得成本优化，根据您过往7天使用情况，预计成本可以下降16%。
RecommendAction	string	事件发生后的推荐操作。可能值： ModifyDiskSpec：变配 CreateSnapshot：打快照 ResizeDisk：扩容 AdjustProvision：调节预配置等 ModifyInstanceSpec：实例变配	AdjustProvision
RecommendParams	string	事件发生后的推荐操作的参数。	4296
EventLevel	string	事件级别，可能值： INFO WARN CRITICAL	INFO
EndTime	string	事件结束时间戳（毫秒级）。	1679538083000
ExtraAttributes	string	附加属性，可能的字段有： EcsInstanceId：云盘挂载的 ECS 实例 ID； Adapter：云盘挂载点。	{\"EcsInstanceId\":\"i-uf6dkn9qpcw6y94g7ag7\",\"Adapter\":\"hda\"}

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2****",
  "ResourceEvents": [
    {
      "EventType": "Alert",
      "EventName": "DiskIOHang",
      "ResourceId": "d-bp67acfmxazb4p****\n",
      "ResourceType": "disk",
      "Status": "WillExecute",
      "StartTime": "1684204822000",
      "Description": "可通过购买4296预配置IOPS以获得成本优化，根据您过往7天使用情况，预计成本可以下降16%。",
      "RecommendAction": "AdjustProvision",
      "RecommendParams": "4296",
      "EventLevel": "INFO",
      "EndTime": "1679538083000",
      "ExtraAttributes": "{\\\"EcsInstanceId\\\":\\\"i-uf6dkn9qpcw6y94g7ag7\\\",\\\"Adapter\\\":\\\"hda\\\"}"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	App.NumberExceed	The number of apps exceeded.	app数量超过限制
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	文档转换失败，文件大小超过系统限额。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	标签中存在重复的键，请保持键的唯一性。
400	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	如果您提供了一个已经使用过的ClientToken，但其他请求参数有变化。
400	InvalidDiskSize.NotSupported	The specified parameter size is not valid.	不支持的云盘大小
400	InvalidParameter	The parameter %s is invalid.	参数错误
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.	参数冲突
400	InvalidParameter.EndTime	The specified parameter EndTime is earlier than StartTime.	参数 EndTime 早于 StartTime。
400	InvalidParameter.Format	Specified parameter format is not valid.	返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
400	InvalidParameter.TooManyDataQueried	Too many data queried.	查询数据过多。
403	AliCroup2CloudUserCannotBuyNotInnerCommodity	There is no group cloud commodity label, and users within the group are not allowed to purchase.	无集团上云商品标签，不允许集团内部用户购买。
403	Forbidden	User is not authorized to operate.	当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403	Forbidden.Action	User is not authorized to operate this action.	当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403	IncorrectDiskStatus.CreatingSnapshot	A previous snapshot creation is in process.	创建快照时有前序快照正在被创建
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	您的账户余额不足。
403	InvalidDiskCategory.NotSupported	The specified disk category is not supported.	当前操作不支持您指定的磁盘类型。请检查您的输入参数和API文档。
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.	找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
404	NoSuchResource	The specified resource does not exist.	指定的资源不存在。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
504	RequestTimeout	The request is timeout, please try again later.	该请求超时，请稍后再重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-19	OpenAPI 错误码发生变更	查看变更详情