调用DescribeMaintenanceAction接口查询运维事件的详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMaintenanceAction

系统规定参数。取值:DescribeMaintenanceAction

Region String cn-hangzhou

地域。取值如下:

  • 运维事件所在地域的地域ID,如cn-hangzhou。您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。
  • 您也可以输入all查看当前账号下所有地域下的所有运维事件,当Region设置为all时,TaskType也必须设置为all
TaskType String rds_apsaradb_upgrade

运维事件的类型,取值如下:

  • rds_apsaradb_upgrade:数据库软件升级。
  • all:查看当前账号下所有地域下的所有运维事件,当Region设置为all时,TaskType也必须设置为all
IsHistory Integer 1

指定返回待处理或历史运维事件的详情,取值如下:

  • 0:返回待处理运维事件的详情。
  • 1:返回历史运维事件的详情。

若该参数留空,默认返回待处理运维事件的详情。

PageSize Integer 30

每页记录数,取值为30(默认值)、50100

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值。默认值为1

RegionId String cn-hangzhou

运维事件所在地域的地域ID。

说明 您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

页码。

RequestId String E774C8A9-8819-4A09-9E91-07C078******

请求ID。

PageSize Integer 30

每页记录数。

TotalRecordCount Integer 2

总记录数。

Items Array of Items

事件列表。

Status String SUCCESS

事件状态。

  • 若您设置IsHistory0,则返回待处理运维事件状态的详情,取值范围如下:
    • WAITING_MODIFY:等待用户设置运维事件开始时间。
    • WAITING:运维事件正在等待处理。
    • PROCESSING:运维事件正在处理中(不支持修改处于该状态下事件的切换时间)。
  • 若您设置IsHistory1,则返回历史运维事件状态的详情,取值范围如下:
    • SUCCESS:事件结束且执行成功。
    • FAILED:事件结束但执行失败。
    • CANCEL:事件已取消。
Deadline String 2021-07-04T15:59:59Z

运维事件执行时间可调整范围的最晚时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PrepareInterval String 02:00:00

运维事件切换之前所需的准备时间,格式为HH:mm:ss

DBType String analyticdb

数据库的引擎类型。

StartTime String 2021-07-03T04:00:00Z

后台执行该运维事件的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

TaskType String rds_apsaradb_upgrade

运维事件的类型。

DBVersion String 3.0

数据库引擎版本号。

DBClusterId String am-****************

运维事件所涉及集群的集群ID。

ModifiedTime String 2021-07-03T06:33:00Z

修改运维事件切换时间的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Region String cn-hangzhou

运维事件所在地域的地域ID。

ResultInfo String autoCancel

运维事件的执行结果。

说明 仅当Status(状态)取值为FAILED(运维事件结束但执行失败)或CANCEL(事件已取消)时,返回该参数。
CreatedTime String 2021-06-30T02:44:27Z

运维事件的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Id Integer 11111

运维事件的ID。

SwitchTime String 2021-07-03T06:00:00Z

运维事件预计的切换时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeMaintenanceAction
&Region=cn-hangzhou
&TaskType=rds_apsaradb_upgrade
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMaintenanceActionResponse>
    <TotalRecordCount>2</TotalRecordCount>
    <RequestId>E774C8A9-8819-4A09-9E91-07C078******</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Items>
        <Status>SUCCESS</Status>
        <CreatedTime>2021-06-30T02:44:27Z</CreatedTime>
        <Deadline>2021-07-04T15:59:59Z</Deadline>
        <StartTime>2021-07-03T04:00:00Z</StartTime>
        <DBClusterId>am-****************</DBClusterId>
        <DBType>analyticdb</DBType>
        <DBVersion>3.0</DBVersion>
        <ModifiedTime>2021-07-03T06:33:00Z</ModifiedTime>
        <TaskType>rds_apsaradb_upgrade</TaskType>
        <PrepareInterval>02:00:00</PrepareInterval>
        <Region>cn-hangzhou</Region>
        <Id>11111</Id>
        <SwitchTime>2021-07-03T06:00:00Z</SwitchTime>
    </Items>
    <Items>
        <Status>CANCEL</Status>
        <CreatedTime>2021-06-25T06:32:45Z</CreatedTime>
        <Deadline>2021-06-29T15:59:59Z</Deadline>
        <StartTime>2021-06-26T16:10:00Z</StartTime>
        <DBClusterId>am-****************</DBClusterId>
        <DBType>analyticdb</DBType>
        <DBVersion>3.0</DBVersion>
        <ModifiedTime>2021-06-26T18:40:00Z</ModifiedTime>
        <TaskType>rds_apsaradb_upgrade</TaskType>
        <PrepareInterval>02:00:00</PrepareInterval>
        <Region>cn-hangzhou</Region>
        <Id>22222</Id>
        <ResultInfo>autoCancel</ResultInfo>
        <SwitchTime>2021-06-26T18:10:00Z</SwitchTime>
    </Items>
</DescribeMaintenanceActionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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