首页 云数据库 Redis 开发参考 OpenAPI API参考 API目录 运维任务管理 DescribeActiveOperationTask - 查询运维任务详情

DescribeActiveOperationTask - 查询运维任务详情

更新时间: 2023-08-25 18:21:11

查询Redis实例的运维任务详情。

接口说明

调用本接口查询到当前有运维任务后，您还可以调用ModifyActiveOperationTask修改运维任务的计划切换时间。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

说明 取值为all表示所有地域ID。
all
TaskTypestring是

任务类型，取值：

  • rds_apsaradb_ha：主从节点切换。
  • rds_apsaradb_transfer：实例迁移。
  • rds_apsaradb_upgrade：小版本升级。
  • all：所有任务类型。
all
IsHistoryinteger否

是否返回历史任务，取值：

  • 0：默认值，返回当前任务。
  • 1：返回历史任务。
1
PageSizeinteger否

每页可展示的最大记录数，取值需大于10，默认值为30。

30
PageNumberinteger否

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

1

返回参数

名称类型描述示例值
object
PageNumberinteger

页码。

1
RequestIdstring

请求ID。

2E1FF0CC-F42A-4B6F-A1F4-A17B1451****
PageSizeinteger

每页可展示的最大记录数。

30
TotalRecordCountinteger

总记录数。

1
Itemsobject []

运维任务列表。

Statusinteger

任务状态，返回值：

  • 2：等待用户指定时间。
  • 3：等待处理。
  • 4：处理中。进入此状态后，不可调用ModifyActiveOperationTask修改计划切换时间）。
  • 5：成功。
  • 6：失败。
  • 7：已取消。
5
Deadlinestring

运维任务执行时间可调整范围的最晚期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2023-03-29T13:59:59Z
PrepareIntervalstring

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

14:00:00
TaskTypestring

任务类型，返回值：

  • rds_apsaradb_ha：主从节点切换。
  • rds_apsaradb_transfer：实例迁移。
  • rds_apsaradb_upgrade：小版本升级。
  • all：所有任务类型。
rds_apsaradb_upgrade
StartTimestring

运维任务执行的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2023-03-20T02:40:00Z
ModifiedTimestring

运维任务修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2023-02-24T08:18:53Z
InsNamestring

Redis实例ID。

r-bp1lgal1sdvxrz****
DbTypestring

数据库类型，返回值：redis。

redis
Regionstring

地域ID。

cn-hanghzou
CreatedTimestring

运维任务的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2023-02-24T06:00:11Z
Idinteger

运维任务ID。

1****1
SwitchTimestring

系统发起的切换操作的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2023-03-20T03:10:00Z

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "2E1FF0CC-F42A-4B6F-A1F4-A17B1451****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "Deadline": "2023-03-29T13:59:59Z",
      "PrepareInterval": "14:00:00",
      "TaskType": "rds_apsaradb_upgrade",
      "StartTime": "2023-03-20T02:40:00Z",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "r-bp1lgal1sdvxrz****",
      "DbType": "redis",
      "Region": "cn-hanghzou",
      "CreatedTime": "2023-02-24T06:00:11Z",
      "Id": 0,
      "SwitchTime": "2023-03-20T03:10:00Z"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400RequiredParam.NotFoundRequired input param is not found.

访问错误中心查看更多错误码。
阿里云首页 云数据库 Redis 相关技术圈