调用DescribeActiveOperationTask查询运维任务详情-云数据库 MongoDB 版-阿里云

查询运维任务详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeActiveOperationTask

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Region	string	是	待处理事件所属的地域 ID，可通过 DescribeRegions 查询。all 代表查询该用户下所有的任务，此参数为 all， taskType 也必须为 all。	cn-shanghai
TaskType	string	是	任务类型，取值： rds_apsaradb_ha：主从节点切换。 rds_apsaradb_transfer：实例迁移。 rds_apsaradb_upgrade：小版本升级。取值来源 DescribeHistoryTasks 。传入 all 代表查询该用户下所有的任务，此参数为 all 时， region 也必须为 all。	rds_apsaradb_ha
IsHistory	integer	否	是否返回历史任务，取值： 0：默认值，返回当前任务。 1：返回历史任务。	0
PageSize	integer	否	每页可展示的最大记录数，取值需大于 10，默认值为 30。	30
PageNumber	integer	否	页码，大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
ProductId	string	否	产品 ID。	MongoDB

返回参数

名称	类型	描述	示例值
	object
TotalRecordCount	integer	总记录数。	0
RequestId	string	请求 ID。	6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
PageSize	integer	每页记录数，默认值为 30。	30
PageNumber	integer	页码，默认值为 1。	1
Items	array<object>	任务列表。
	object
Status	integer	任务状态，返回值： 2：等待用户指定时间。 3：等待处理。 4：处理中。进入此状态后，不可修改计划切换时间。 5：成功。 6：失败。 7：已取消。	2
TaskParams	string	任务参数。	""
PrepareInterval	string	运维任务开始时间到切换时间之间所需的准备时间，格式为 HH:mm:ss。	14:00:00
Deadline	string	运维任务执行时间可调整范围的最晚期时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2023-03-29T13:59:59Z
StartTime	string	运维任务执行的时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2023-03-20T02:40:00Z
TaskType	string	任务类型，返回值： rds_apsaradb_ha：主从节点切换。 rds_apsaradb_transfer：实例迁移。 rds_apsaradb_upgrade：小版本升级。	rds_apsaradb_ha
ModifiedTime	string	运维任务修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2023-02-24T08:18:53Z
InsName	string	实例 ID。	dds-bp12721xxxx9b914
DbType	string	数据库类型。	mongodb
Region	string	地域 ID。	cn-beijing
ResultInfo	string	执行结果信息。	""
CreatedTime	string	运维任务创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2024-11-06T13:11:08Z
Id	integer	任务 ID。	50xx
SwitchTime	string	运维任务切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2024-11-06T14:11:08Z

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 0,
  "RequestId": "6FD47DC4-0750-5524-A89E-E7D559Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 2,
      "TaskParams": "\"\"",
      "PrepareInterval": "14:00:00",
      "Deadline": "2023-03-29T13:59:59Z",
      "StartTime": "2023-03-20T02:40:00Z",
      "TaskType": "rds_apsaradb_ha",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "dds-bp12721xxxx9b914",
      "DbType": "mongodb",
      "Region": "cn-beijing",
      "ResultInfo": "\"\"",
      "CreatedTime": "2024-11-06T13:11:08Z",
      "Id": 0,
      "SwitchTime": "2024-11-06T14:11:08Z\n"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	RequiredParam.NotFound	Required input param is not found.

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

变更历史

更多信息，参考变更详情。