DescribeActiveOperationTasks - 查询多个主动运维任务信息

更新时间:2025-01-22 03:50:44

查询实例的运维事件详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
polardb:DescribeActiveOperationTasksget
*全部资源
*

请求参数

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

待处理事件所属的地域 ID。

说明
您可以通过 DescribeRegions 接口查看可用地域。
cn-beijing
TaskTypestring

待处理事件的任务类型,取值范围如下:

  • DatabaseSoftwareUpgrading:数据库软件升级
  • DatabaseHardwareMaintenance:硬件维护与升级
  • DatabaseStorageUpgrading:数据库存储升级
  • DatabaseProxyUpgrading:代理小版本升级
  • all:表示查询上述所有类型的待处理事件详情
说明
Region设置为 all 时,TaskType也必须设置为 all
DatabaseProxyUpgrading
PageSizeinteger

每页记录数,取值范围如下:

  • 30(默认)
  • 50
  • 100
30
PageNumberinteger

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

1
DBTypestring

数据库引擎类型。取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
Statuslong

任务状态。取值范围如下:

  • -1:全部任务。
  • 3:待处理任务。
  • 4:处理中任务。
  • 5:成功结束任务。
  • 6:失败结束任务。
  • 7:已取消任务。
-1
DBClusterIdstring

集群 ID。

说明
您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息,包括集群 ID。
pc-3ns***********d5d
AllowChangelong

是否允许修改时间。取值范围如下:

  • -1(默认):全部。
  • 0:只返回不允许修改时间的任务。
  • 1:只返回允许修改时间的任务。
-1
AllowCancellong

是否允许取消。取值范围如下:

  • -1(默认):全部。
  • 0:只返回不允许取消的任务。
  • 1:只返回允许取消的任务。
-1
ChangeLevelstring

任务级别。取值范围如下:

  • all(默认):全部。
  • S0:返回异常修复级别的任务。
  • S1:返回系统运维级别的任务。
all

返回参数

名称类型描述示例值
名称类型描述示例值
object
TotalRecordCountinteger

返回的任务记录数。

1
RequestIdstring

请求 ID。

FAF88508-D5F8-52B1-8824-262601769E31
PageSizeinteger

每页记录数,取值范围:

  • 30
  • 50
  • 100

默认值为 30

30
PageNumberinteger

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

1
Itemsarray<object>

运维任务列表。

Itemsobject

运维任务列表。

Statusinteger

任务状态。取值范围如下:

  • 0:表示等待通知。
  • 1:表示重试通知。
  • 2:表示等待用户指定时间。
  • 3:表示等待处理。
  • 4:表示处理中。
  • 5:表示成功结束。
  • 6:表示失败结束。
  • 7:已取消。
3
PrepareIntervalstring

开始时间到切换时间之间所需的准备时间。格式为 HH:mm:ss。

04:00:00
Deadlinestring

任务执行时间可调整范围的最晚期限。格式为:YYYY-MM-DDTHH:mm:ssZ。

2020-06-11T15:59:59Z
DBTypestring

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
TaskTypestring

待处理事件的任务类型,取值范围如下:

  • DatabaseSoftwareUpgrading:数据库软件升级。
  • DatabaseHardwareMaintenance:硬件维护与升级。
  • DatabaseStorageUpgrading:数据库存储升级。
  • DatabaseProxyUpgrading:代理小版本升级。
  • all:表示查询上述所有类型的待处理事件详情。
DatabaseSoftwareUpgrading
StartTimestring

后台执行任务的时间点。格式为:YYYY-MM-DDTHH:mm:ssZ。

2023-05-19T02:48:17Z
DBVersionstring

内核版本号。

8.0
ModifiedTimestring

修改时间。格式为:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:42Z
DBClusterIdstring

集群 ID。

pc-*****************
Regionstring

区域代码。

cn-hangzhou
ResultInfostring

执行结果信息。

userCancel
CreatedTimestring

创建时间。格式为:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:42Z
TaskIdinteger

任务 ID。

107202351
SwitchTimestring

后台发起切换操作的时间点。格式为:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:00Z
CurrentAVZstring

当前可用区。

cn-beijing-h
InsCommentstring

集群别名,集群备注。

test
TaskTypeZhstring

任务原因中文。

小版本升级
TaskTypeEnstring

任务原因英文。

Minor version update
ChangeLevelstring

事件等级代码。取值范围如下:

  • S1:系统运维。
  • S0:风险修复。
S0
ChangeLevelZhstring

事件等级(中文)。

系统运维
ChangeLevelEnstring

事件等级(英文)。

System maintenance
ImpactZhstring

事件影响(中文)。

集群闪断
ImpactEnstring

事件影响(英文)。

Transient instance disconnection
AllowChangelong

是否允许修改时间。取值范围如下:

  • 1:表示允许用户修改时间。
  • 0:表示不允许用户修改时间。
0
AllowCancellong

是否允许取消。取值范围如下:

  • 1:表示允许用户取消任务。
  • 0:表示不允许取消。
0
Impactstring

事件影响。

TransientDisconnection
DBNodeIdsarray

节点 id 列表。

subInsNamesstring

节点 ID。支持传入多个节点 ID,多个 ID 间用英文逗号(,)分隔。

pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i
TaskParamsstring

任务参数。

{ "Action": "UpgradeDBInstance" }

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "RequestId": "FAF88508-D5F8-52B1-8824-262601769E31",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 3,
      "PrepareInterval": "04:00:00",
      "Deadline": "2020-06-11T15:59:59Z",
      "DBType": "MySQL",
      "TaskType": "DatabaseSoftwareUpgrading",
      "StartTime": "2023-05-19T02:48:17Z",
      "DBVersion": "8.0",
      "ModifiedTime": "2020-06-09T22:00:42Z",
      "DBClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "ResultInfo": "userCancel",
      "CreatedTime": "2020-06-09T22:00:42Z",
      "TaskId": 107202351,
      "SwitchTime": "2020-06-09T22:00:00Z",
      "CurrentAVZ": "cn-beijing-h",
      "InsComment": "test",
      "TaskTypeZh": "小版本升级",
      "TaskTypeEn": "Minor version update",
      "ChangeLevel": "S0",
      "ChangeLevelZh": "系统运维",
      "ChangeLevelEn": "System maintenance",
      "ImpactZh": "集群闪断",
      "ImpactEn": "Transient instance disconnection",
      "AllowChange": 0,
      "AllowCancel": 0,
      "Impact": "TransientDisconnection",
      "DBNodeIds": [
        "pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InvalidPageParam.FormatPage param should be a positive integer.页参数应为正整数,请检查后重新设置。
400RequiredParam.NotFoundRequired input param is not found.所需的输入参数不存在。

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码

点击开启售前

在线咨询服务