文档

DescribeActiveOperationTasks - 查询运维任务列表

更新时间:

查询MongoDB实例的运维任务列表。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

说明 all 表示查询该用户下所有的任务,当此参数传入值为 all 时, taskType 参数的值也必须为 all
cn-beijing
TaskTypestring

任务类型。

***
PageSizeinteger

每页记录数,取值: 30、50、100,默认值为 30

30
PageNumberinteger

页码。

1
ProductIdstring

产品 ID。

***
DbTypestring

数据库类型。

***
Statusinteger

任务状态。

  • 0:等待执行。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
0
InsNamestring

实例的名称。

dds-bp16aaccfe10****
AllowChangeinteger

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

  • 0:不允许修改。
  • 1:允许修改。
1
AllowCancelinteger

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

  • 0:不允许取消。
  • 1:允许取消。
***
ChangeLevelstring

变更类型。取值如下:

  • all(默认):全部运维。
  • S0:异常修复。
  • S1:系统运维。
***

返回参数

名称类型描述示例值
object
PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

111E7B16-0A87-4CBA-B271-F34AD61E099F
PageSizeinteger

每页记录数。

30
TotalRecordCountinteger

总记录数。

727
Itemsobject []

运维任务列表。

Statusinteger

暂无说明

***
ChangeLevelEnstring

暂无说明

***
TaskTypestring

任务类型。

***
InsNamestring

节点 ID。

***
Regionstring

区域。

cn-hangzhou
ImpactZhstring

暂无说明

***
CreatedTimestring

创建时间。

2021-07-14 10:48:43.0
SwitchTimestring

切换时间点,可能产生闪断,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2022-11-24T11:20:00Z
ChangeLevelZhstring

任务类型(英文)。

***
Deadlinestring

截止时间。

1646014421633
PrepareIntervalstring

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

***
TaskTypeZhstring

任务类型中文。

***
CurrentAVZstring

暂无说明。

***
AllowChangestring

是否允许修改:

  • 0:否。
  • 1:是。
0
DbVersionstring

数据库引擎版本号。

5.6
ImpactEnstring

暂无说明

***
InsCommentstring

描述。

***
StartTimestring

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

2022-12-24T06:01Z
ModifiedTimestring

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

2021-08-24T09:48:01.000+00:00
AllowCancelstring

暂无说明

***
DbTypestring

数据库引擎类型。

mongoDb
ChangeLevelstring

变更级别。

***
TaskTypeEnstring

暂无说明

***
ResultInfostring

结果信息(可忽略)。

***
Idinteger

任务 id。

***
SubInsNamesarray

子实例列表。

string

子实例列表项。

***

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "PageSize": 30,
  "TotalRecordCount": 727,
  "Items": [
    {
      "Status": 0,
      "ChangeLevelEn": "***",
      "TaskType": "***",
      "InsName": "***",
      "Region": "cn-hangzhou",
      "ImpactZh": "***",
      "CreatedTime": "2021-07-14 10:48:43.0",
      "SwitchTime": "2022-11-24T11:20:00Z",
      "ChangeLevelZh": "***",
      "Deadline": "1646014421633",
      "PrepareInterval": "***",
      "TaskTypeZh": "***",
      "CurrentAVZ": "***",
      "AllowChange": "0",
      "DbVersion": "5.6",
      "ImpactEn": "***",
      "InsComment": "***",
      "StartTime": "2022-12-24T06:01Z",
      "ModifiedTime": "2021-08-24T09:48:01.000+00:00",
      "AllowCancel": "***",
      "DbType": "mongoDb",
      "ChangeLevel": "***",
      "TaskTypeEn": "***",
      "ResultInfo": "***",
      "Id": 0,
      "SubInsNames": [
        "***"
      ]
    }
  ]
}

错误码

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

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