文档

DescribeMaintenanceAction - 查询运维事件的详情

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeMaintenanceActionRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/*

请求参数

名称类型必填描述示例值
Regionstring

地域。取值如下:

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

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

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

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

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

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

1
PageSizeinteger

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

30
PageNumberinteger

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

1
RegionIdstring

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

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

返回参数

名称类型描述示例值
object

详情。

PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

E774C8A9-8819-4A09-9E91-07C078******
PageSizeinteger

每页记录数。

30
TotalRecordCountinteger

总记录数。

2
Itemsobject []

事件列表。

Statusstring

事件状态。

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

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

2021-07-04T15:59:59Z
PrepareIntervalstring

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

02:00:00
DBTypestring

数据库的引擎类型。

analyticdb
StartTimestring

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

2021-07-03T04:00:00Z
TaskTypestring

运维事件的类型。

rds_apsaradb_upgrade
DBVersionstring

数据库引擎版本号。

3.0
DBClusterIdstring

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

am-****************
ModifiedTimestring

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

2021-07-03T06:33:00Z
Regionstring

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

cn-hangzhou
ResultInfostring

运维事件的执行结果。

说明 仅当Status(状态)取值为 FAILED(运维事件结束但执行失败)或 CANCEL(事件已取消)时,返回该参数。
autoCancel
CreatedTimestring

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

2021-06-30T02:44:27Z
Idinteger

运维事件的 ID。

11111
SwitchTimestring

运维事件预计的切换时间,格式为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错误码错误信息
400RequiredParam.NotFoundRequired input param is not found.

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

  • 本页导读 (1)
文档反馈