All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTasks

    Document Center

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTasks

    Last Updated:Oct 27, 2026

    Queries the details of O&M events 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 of the pending events. You can call the DescribeRegions operation to query the region ID.

    Note

    A value of all specifies all region IDs.

    cn-shanghai
    TaskType

    string

    No

    The O&M event type. If this parameter is left empty, all event types are queried.

    Valid values:

    • rds_apsradb_upgrade :

      Minor version upgrade.

    • rds_apsaradb_ha :

      Primary/secondary switchover.

    • rds_apsaradb_ssl_update :

      SSL certificate update.

    • rds_apsaradb_major_upgrade :

      Major engine version upgrade.

    • rds_apsradb_transfer :

      Instance migration.

    • rds_apsaradb_network_upgrade :

      Network upgrade.

    • rds_apsaradb_modify_config :

      Instance parameter adjustment.

    • rds_apsaradb_maxscale :

      Proxy minor version upgrade.

    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. The value must be greater than 0. Default value: 1.

    1
    ProductId

    string

    No

    The product name. Valid values: RDS, POLARDB, MongoDB, and Redis. For Redis instances, you can set this parameter to Redis.

    Redis
    DbType

    string

    No

    The database engine type. Set the value to redis.

    redis
    Status

    integer

    No

    The status of the O&M event, which is used to filter the returned tasks. Valid values:

    • -1: all events

    • 3: pending

    • 4: in progress

    • 5: succeeded

    • 6: failed

    • 7: canceled

    3
    InsName

    string

    No

    The instance name. This parameter is optional. If you specify this parameter, you can specify only one instance name.

    r-wz96fzmpvpr2qnqnlb
    AllowChange

    integer

    No

    Specifies whether the execution time can be modified. Default value: -1. Valid values:

    • -1: all events

    • 0: Only O&M events whose execution time cannot be modified are returned.

    • 1: Only O&M events whose execution time can be modified are returned.

    -1
    AllowCancel

    integer

    No

    Specifies whether the event can be canceled. Default value: -1. Valid values:

    • -1: all events

    • 0: Only O&M events that cannot be canceled are returned.

    • 1: Only O&M events that can be canceled are returned.

    1
    ChangeLevel

    string

    No

    The change level. Default value: all. Valid values:

    • all: all exception repair and system O&M levels

    • S0: exception repair

    • S1: system O&M

    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 total number of returned O&M event records.

    1
    Items

    array<object>

    The list of O&M events.

    object

    The details of the O&M event.

    Status

    integer

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

    • 3: pending

    • 4: in progress

    • 5: succeeded

    • 6: failed

    • 7: canceled

    5
    ChangeLevelEn

    string

    The event level in English.

    System maintenance

    TaskType

    string

    The O&M event type.

    rds_apsaradb_transfer
    InsName

    string

    The instance ID.

    r-bp1lgal1sdvxrz****
    Region

    string

    The region ID.

    cn-hanghzou
    ImpactZh

    string

    The event impact in Chinese.

    Transient instance disconnection
    CreatedTime

    string

    The time when the event was created. The time is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.

    2018-05-30T14:30:00Z

    SwitchTime

    string

    The time when the backend initiated the switchover operation. The time is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.

    2018-05-30T14:30:00Z

    ChangeLevelZh

    string

    The event level in Chinese.

    System O&M
    Deadline

    string

    The latest time within the adjustable range for the task execution time. The time is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.

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

    string

    The preparation time required between the start time and the switchover time. The time is in the HH:mm:ss format.

    04:00:00

    TaskTypeZh

    string

    The task cause in Chinese.

    Minor version upgrade
    CurrentAVZ

    string

    The current zone.

    cn-beijing-h

    AllowChange

    string

    Indicates whether the execution time can be modified. A value of 1 indicates that users are allowed to modify the execution time. A value of 0 indicates that users are not allowed to modify the execution time.

    1
    DbVersion

    string

    The kernel version number.

    5.0
    ImpactEn

    string

    The event impact in English.

    Transient instance disconnection
    InsComment

    string

    The instance alias or description.

    test
    StartTime

    string

    The time when the backend executes the event. The time is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.

    2018-05-30T00:00:00Z

    ModifiedTime

    string

    The time when the event was modified. The time is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.

    2018-05-30T14:30:00Z

    AllowCancel

    string

    Indicates whether the event can be canceled. A value of 1 indicates that users are allowed to cancel the event. A value of 0 indicates that users are not allowed to cancel the event.

    1
    DbType

    string

    The database engine type. Valid value: redis.

    redis
    ChangeLevel

    string

    The event level code. S1 indicates system O&M, and S0 indicates exception repair.

    S1
    TaskTypeEn

    string

    The cause of the O&M event in English.

    Minor version update
    ResultInfo

    string

    The execution result information.

    userCancel
    Id

    integer

    The O&M event ID.

    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 event impact.

    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": "Transient instance disconnection",
      "CreatedTime": "2018-05-30T14:30:00Z\n",
      "SwitchTime": "2018-05-30T14:30:00Z\n",
      "ChangeLevelZh": "System O&M",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00\n",
      "TaskTypeZh": "Minor version upgrade",
      "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.