调用DescribeMaintenanceAction查询运维事件的详情_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用DescribeMaintenanceAction接口查询运维事件的详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Region	string	是	地域。取值如下：运维事件所在地域的地域 ID，如`cn-hangzhou`。您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。您也可以输入`all`查看当前账号下所有地域下的所有运维事件，当`Region`设置为`all`时，`TaskType`也必须设置为`all`。	cn-hangzhou
TaskType	string	是	运维事件的类型，取值如下： rds_apsaradb_upgrade：数据库软件升级。 all：查看当前账号下所有地域下的所有运维事件，当`Region`设置为`all`时，`TaskType`也必须设置为`all`。	rds_apsaradb_upgrade
IsHistory	integer	否	指定返回待处理或历史运维事件的详情，取值如下： 0：返回待处理运维事件的详情。 1：返回历史运维事件的详情。若该参数留空，默认返回待处理运维事件的详情。	1
PageSize	integer	否	每页记录数，取值为 30（默认值）、50 或 100。	30
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。	1
RegionId	string	是	运维事件所在地域的地域 ID。说明您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	详情。
PageNumber	integer	页码。	1
RequestId	string	请求 ID。	E774C8A9-8819-4A09-9E91-07C078******
PageSize	integer	每页记录数。	30
TotalRecordCount	integer	总记录数。	2
Items	array<object>	事件列表。
Items	object	详情。
Status	string	事件状态。若您设置`IsHistory`为 0，则返回待处理运维事件状态的详情，取值范围如下： WAITING_MODIFY：等待用户设置运维事件开始时间。 WAITING：运维事件正在等待处理。 PROCESSING：运维事件正在处理中（不支持修改处于该状态下事件的切换时间）。若您设置`IsHistory`为 1，则返回历史运维事件状态的详情，取值范围如下： SUCCESS：事件结束且执行成功。 FAILED：事件结束但执行失败。 CANCEL：事件已取消。	SUCCESS
Deadline	string	运维事件执行时间可调整范围的最晚时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2021-07-04T15:59:59Z
PrepareInterval	string	运维事件切换之前所需的准备时间，格式为`HH:mm:ss`。	02:00:00
DBType	string	数据库的引擎类型。	analyticdb
StartTime	string	后台执行该运维事件的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2021-07-03T04:00:00Z
TaskType	string	运维事件的类型。	rds_apsaradb_upgrade
DBVersion	string	数据库引擎版本号。	3.0
DBClusterId	string	运维事件所涉及集群的集群 ID。	am-****************
ModifiedTime	string	修改运维事件切换时间的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2021-07-03T06:33:00Z
Region	string	运维事件所在地域的地域 ID。	cn-hangzhou
ResultInfo	string	运维事件的执行结果。说明仅当`Status`（状态）取值为 FAILED（运维事件结束但执行失败）或 CANCEL（事件已取消）时，返回该参数。	autoCancel
CreatedTime	string	运维事件的创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2021-06-30T02:44:27Z
Id	integer	运维事件的 ID。	11111
SwitchTime	string	运维事件预计的切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2021-07-03T06:00:00Z

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "E774C8A9-8819-4A09-9E91-07C078******",
  "PageSize": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "SUCCESS",
      "Deadline": "2021-07-04T15:59:59Z",
      "PrepareInterval": "02:00:00",
      "DBType": "analyticdb",
      "StartTime": "2021-07-03T04:00:00Z",
      "TaskType": "rds_apsaradb_upgrade",
      "DBVersion": "3.0",
      "DBClusterId": "am-****************",
      "ModifiedTime": "2021-07-03T06:33:00Z",
      "Region": "cn-hangzhou",
      "ResultInfo": "autoCancel",
      "CreatedTime": "2021-06-30T02:44:27Z",
      "Id": 11111,
      "SwitchTime": "2021-07-03T06:00:00Z"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	RequiredParam.NotFound	Required input param is not found.

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史