全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：DescribeActiveOperationTask - 查询运维任务详情

    文档中心

    云数据库 Tair（兼容 Redis®）：DescribeActiveOperationTask - 查询运维任务详情

    更新时间：Oct 26, 2026

    查询云数据库 Tair（兼容 Redis）实例的运维任务详情。

    接口说明

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

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    kvstore:DescribeActiveOperationTask

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Region

    string

    是

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

    说明

    取值为 all 表示所有地域 ID。

    all
    TaskType

    string

    是

    任务类型，取值：

    • rds_apsaradb_ha：主备节点切换。

    • rds_apsaradb_transfer：实例迁移。

    • rds_apsaradb_upgrade：小版本升级。

    rds_apsaradb_ha
    IsHistory

    integer

    否

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

    • 0：默认值，返回当前任务。

    • 1：返回历史任务。

    1
    PageSize

    integer

    否

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

    30
    PageNumber

    integer

    否

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

    1

    返回参数

    名称

    类型

    描述

    示例值

    object

    PageNumber

    integer

    页码。

    1
    RequestId

    string

    请求 ID。

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

    integer

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

    30
    TotalRecordCount

    integer

    总记录数。

    1
    Items

    array<object>

    运维任务列表。

    object

    Status

    integer

    任务状态，返回值：

    • 2：等待用户指定时间。

    • 3：等待处理。

    • 4：处理中。进入此状态后，不可调用 ModifyActiveOperationTask 修改计划切换时间。

    • 5：成功。

    • 6：失败。

    • 7：已取消。

    5
    Deadline

    string

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

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

    string

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

    14:00:00
    TaskType

    string

    任务类型，返回值：

    • rds_apsaradb_ha：主备节点切换。

    • rds_apsaradb_transfer：实例迁移。

    • rds_apsaradb_upgrade：小版本升级。

    • all：所有任务类型。

    rds_apsaradb_upgrade
    StartTime

    string

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

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

    string

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

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

    string

    实例 ID。

    r-bp1lgal1sdvxrz****
    DbType

    string

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

    redis
    Region

    string

    地域 ID。

    cn-hanghzou
    CreatedTime

    string

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

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

    integer

    运维任务 ID。

    1****1
    SwitchTime

    string

    系统发起的切换操作的时间，格式为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

    错误码

    错误信息

    描述
    400 RequiredParam.NotFound Required input param is not found. 缺少输入参数

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

    变更历史

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