All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTasks

    Document Center

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTasks

    Last Updated:Aug 28, 2026

    Queries active O&M event details for an instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeActiveOperationTasks

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Region

    string

    No

    The region ID. Call DescribeRegions to query available region IDs.

    Note

    A value of all indicates all region IDs.

    cn-shanghai
    TaskType

    string

    No

    The type of O&M event. If not specified, all event types are returned.

    Valid values:

    • rds_apsradb_upgrade: minor version update

    • rds_apsaradb_ha: primary/secondary switchover

    • rds_apsaradb_ssl_update: SSL certificate update

    • rds_apsaradb_major_upgrade: major version upgrade

    • rds_apsradb_transfer: instance migration

    • rds_apsaradb_modify_config: network upgrade

    • rds_apsaradb_modify_config: instance parameter adjustment

    • rds_apsaradb_maxscale: proxy minor version update

    Valid values:

    • rds_apsradb_upgrade :
    • rds_apsaradb_ha :
    • rds_apsaradb_ssl_update :
    • rds_apsaradb_major_upgrade :
    • rds_apsradb_transfer :
    • rds_apsaradb_network_upgrade :
    • rds_apsaradb_modify_config :
    • rds_apsaradb_maxscale :

    rds_apsradb_transfer
    PageSize

    integer

    No

    The number of entries per page. Default value: 25. Maximum value: 100.

    25
    PageNumber

    integer

    No

    The page number. Pages start from page 1. Default value: 1.

    1
    ProductId

    string

    No

    The service name. Valid values: RDS, PolarDB, MongoDB, and Redis. For Redis instances, set this to Redis.

    Redis
    DbType

    string

    No

    The database type. Valid values: redis

    redis
    Status

    integer

    No

    The O&M event status used to filter results. Valid values:

    • -1: filters all events.

    • 3: filters pending events.

    • 4: filters in-progress events.

    • 5: filters successful events.

    • 6: filters failed events.

    • 7: filters canceled events.

    3
    InsName

    string

    No

    The instance name. If specified, only one instance name is supported.

    r-wz96fzmpvpr2qnqnlb
    AllowChange

    integer

    No

    Filters events by whether the switching time can be changed. Default value: -1. Valid values:

    • -1: returns all events.

    • 0: returns only O&M events for which the switching time cannot be changed.

    • -1: returns only O&M events for which the switching time can be changed.

    -1
    AllowCancel

    integer

    No

    Filters events by whether they can be canceled. Default value: -1. Valid values:

    • -1: returns all events.

    • 0: returns only O&M events that cannot be canceled.

    • 1: returns only O&M events that can be canceled.

    1
    ChangeLevel

    string

    No

    The type of task configuration change. Valid values:

    • all (default): The configurations of all O&M tasks are changed.

    • S0: The configurations of tasks initiated to fix exceptions are changed.

    • S1: The configurations of system O&M tasks are changed.

    all

    Response elements

    Element

    Type

    Description

    Example

    object

    PageNumber

    integer

    The page number.

    1
    RequestId

    string

    The request ID.

    2D9F3768-EDA9-4811-943E-42C8006E****
    PageSize

    integer

    The number of entries per page. Default value: 25.

    25
    TotalRecordCount

    integer

    The number of O&M events returned.

    1
    Items

    array<object>

    The list of O&M events.

    object

    Details about the O&M event.

    Status

    integer

    The status of the O&M event. Valid values:

    • 3: filters pending events.

    • 4: filters in-progress events.

    • 5: filters successful events.

    • 6: filters failed events.

    • 7: filters canceled events.

    5
    ChangeLevelEn

    string

    The level of the task in English.

    System maintenance

    TaskType

    string

    The type of the O&M event.

    rds_apsaradb_transfer
    InsName

    string

    The instance ID.

    r-bp1lgal1sdvxrz****
    Region

    string

    The region ID of the instance.

    cn-hanghzou
    ImpactZh

    string

    The impact of the task in Chinese.

    实例闪断

    CreatedTime

    string

    The time when the O&M task was created, in the yyyy-MM-ddThh:mm:ssZ format (UTC).

    2018-05-30T14:30:00Z

    SwitchTime

    string

    The switchover time, in the yyyy-MM-ddThh:mm:ssZ format (UTC).

    2018-05-30T14:30:00Z

    ChangeLevelZh

    string

    The level of the task in Chinese.

    系统运维

    Deadline

    string

    The deadline before which the O&M task schedule can be modified, in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2018-05-30T23:59:59Z
    PrepareInterval

    string

    The preparation period between the task start time and the switchover time, in the HH:mm:ss format.

    04:00:00

    TaskTypeZh

    string

    The reason for the task in Chinese.

    小版本升级

    CurrentAVZ

    string

    The current zone.

    cn-beijing-h

    AllowChange

    string

    Indicates whether the switching time can be changed. Valid values: 1 (changeable) and 0 (not changeable).

    1
    DbVersion

    string

    The version of the database engine.

    5.0
    ImpactEn

    string

    The impact of the task in English.

    Transient instance disconnection
    InsComment

    string

    The alias and description of the instance.

    test
    StartTime

    string

    The backend execution time of the event, in the YYYY-MM-DDTHH:mm:ssZ format (UTC).

    2018-05-30T00:00:00Z

    ModifiedTime

    string

    The time when the O&M task was last modified, in the yyyy-MM-ddThh:mm:ssZ format (UTC).

    2018-05-30T14:30:00Z

    AllowCancel

    string

    Indicates whether the event can be canceled. Valid values: 1 (cancelable) and 0 (not cancelable).

    1
    DbType

    string

    The database type of the instance. The return value is Redis.

    redis
    ChangeLevel

    string

    The task level code. S1 indicates system O&M and S0 indicates exception fixing.

    S1
    TaskTypeEn

    string

    The cause of the O&M event.

    Minor version update
    ResultInfo

    string

    The information about the execution result.

    userCancel
    Id

    integer

    The ID of the O&M event.

    11111
    SubInsNames

    array

    The list of sub-events.

    string

    The name of the sub-event.

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

    TaskParams

    string

    The O&M event parameters.

    { "Action": "UpgradeDBInstance" }
    Impact

    string

    The impact of the task.

    TransientDisconnection

    Examples

    Success response

    JSON format

    {
  "PageNumber": 1,
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "PageSize": 25,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "ChangeLevelEn": "System maintenance\n",
      "TaskType": "rds_apsaradb_transfer",
      "InsName": "r-bp1lgal1sdvxrz****",
      "Region": "cn-hanghzou",
      "ImpactZh": "实例闪断\n",
      "CreatedTime": "2018-05-30T14:30:00Z\n",
      "SwitchTime": "2018-05-30T14:30:00Z\n",
      "ChangeLevelZh": "系统运维\n",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00\n",
      "TaskTypeZh": "小版本升级\n",
      "CurrentAVZ": "cn-beijing-h\n",
      "AllowChange": "1",
      "DbVersion": "5.0",
      "ImpactEn": "Transient instance disconnection",
      "InsComment": "test",
      "StartTime": "2018-05-30T00:00:00Z\n",
      "ModifiedTime": "2018-05-30T14:30:00Z\n",
      "AllowCancel": "1",
      "DbType": "redis",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update",
      "ResultInfo": "userCancel",
      "Id": 11111,
      "SubInsNames": [
        "sub1369716295573-tes2cy6****.2013052818****\n"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}",
      "Impact": "TransientDisconnection"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.