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

查询MongoDB实例的计划内运维任务详情。

调试

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

授权信息

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

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

请求参数

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

待处理事件所属的地域 ID,可调用 DescribeRegions 接口获取。

说明 取值为 all 表示所有地域 ID。
cn-beijing
TaskTypestring

任务类型,取值:

  • rds_apsaradb_ha:主从节点切换。
  • rds_apsaradb_transfer:实例迁移。
  • rds_apsaradb_upgrade:小版本升级。
  • rds_apsaradb_maxscale: 代理小版本升级。
  • all:所有任务类型。
all
PageSizeinteger

每页记录数,取值: 3050100,默认值为 30

30
PageNumberinteger

页码。大于 0,默认为 1

1
ProductIdstring

产品名称,对于 MongoDB 实例可传入 MongoDB

MongoDB
DbTypestring

数据库类型,默认为 all

mongoDb
Statusinteger

任务状态,用于筛选返回任务。

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

实例的名称。可不填,填写时只允许填写至多一个实例名称。

dds-bp16aaccfe10****
AllowChangeinteger

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

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

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

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

任务类型。取值如下:

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

返回参数

名称类型描述示例值
object
PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

111E7B16-0A87-4CBA-B271-F34AD61E****
PageSizeinteger

每页记录数。

30
TotalRecordCountinteger

返回的任务记录数。

1
Itemsarray<object>

运维任务列表。

object
Statusinteger

任务状态。

  • 3:待处理任务。
  • 4:处理中任务。
  • 5:成功结束任务。
  • 6:失败结束任务。
  • 7:已取消任务。
3
ChangeLevelEnstring

事件等级(英文)。

System maintenance
TaskTypestring

任务类型,取值:

  • rds_apsaradb_ha:主从节点切换。
  • rds_apsaradb_transfer:实例迁移。
  • rds_apsaradb_upgrade:小版本升级。
  • rds_apsaradb_maxscale: 代理小版本升级。
  • all:所有任务类型。
rds_apsaradb_upgrade
InsNamestring

实例名。

dds-bp16aaccfe10****
Regionstring

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

cn-beijing
ImpactZhstring

事件影响(中文)。

实例闪断
CreatedTimestring

创建时间,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-05-30T14:30:00Z
SwitchTimestring

后台发起切换操作的时间点,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-05-30T14:30:00Z
ChangeLevelZhstring

事件等级(中文)。

系统运维
Deadlinestring

任务执行时间可调整范围的最晚期限,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-05-30T23:59:59Z
PrepareIntervalstring

运维任务开始时间到切换时间之间所需的准备时间,格式为HH:mm:ss

04:00:00
TaskTypeZhstring

任务原因(中文)。

小版本升级
CurrentAVZstring

当前可用区。

cn-beijing-h
AllowChangestring

是否允许修改时间。

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

数据库引擎版本号。

5.6
ImpactEnstring

事件影响(英文)。

Transient instance disconnection
InsCommentstring

实例别名/实例备注。

test
StartTimestring

后台执行任务的时间点,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-05-30T00:00:00Z
ModifiedTimestring

修改时间,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-05-30T14:30:00Z
AllowCancelstring

是否允许取消。

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

数据库引擎类型。

mongoDb
ChangeLevelstring

事件等级代码。

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

任务原因(英文)。

Minor version update
ResultInfostring

执行结果信息。

userCancel
Idinteger

任务 ID。

11111
SubInsNamesarray

子实例列表。

string

子任务名称。

sub1369716295573-tes2cy6****.2013052818****

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 3,
      "ChangeLevelEn": "System maintenance",
      "TaskType": "rds_apsaradb_upgrade",
      "InsName": "dds-bp16aaccfe10****",
      "Region": "cn-beijing\n",
      "ImpactZh": "实例闪断",
      "CreatedTime": "2023-05-30T14:30:00Z",
      "SwitchTime": "2023-05-30T14:30:00Z",
      "ChangeLevelZh": "系统运维",
      "Deadline": "2023-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00",
      "TaskTypeZh": "小版本升级",
      "CurrentAVZ": "cn-beijing-h",
      "AllowChange": "1",
      "DbVersion": "5.6",
      "ImpactEn": "Transient instance disconnection\n",
      "InsComment": "test",
      "StartTime": "2023-05-30T00:00:00Z",
      "ModifiedTime": "2023-05-30T14:30:00Z\n",
      "AllowCancel": "1",
      "DbType": "mongoDb",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update\n",
      "ResultInfo": "userCancel",
      "Id": 11111,
      "SubInsNames": [
        "sub1369716295573-tes2cy6****.2013052818****"
      ]
    }
  ]
}

错误码

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