All Products
Search

This Product

    ApsaraDB for ClickHouse:DescribeActiveOperationTasks

    Document Center

    ApsaraDB for ClickHouse:DescribeActiveOperationTasks

    Last Updated:Dec 10, 2025

    Queries the active operation tasks of a ClickHouse 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Region

    string

    No

    The region ID.

    cn-beijing
    TaskType

    string

    No

    The task type. Valid values:

    • rds_apsaradb_upgrade: Minor version upgrade.

    • all: All task types.

    all
    PageSize

    integer

    No

    The number of entries to return on each page. Valid values:

    • 30 (Default)

    • 50

    • 100

    30
    PageNumber

    integer

    No

    The page number.

    1
    ProductId

    string

    No

    The product ID.

    clickhouse
    DbType

    string

    No

    The database type.

    clickhouse
    Status

    integer

    No

    The task status. This parameter is used to filter tasks.

    • -1: All tasks.

    • 3: Tasks to be processed.

    • 4: Tasks in progress.

    • 5: Successfully completed tasks.

    • 6: Failed tasks.

    • 7: Canceled tasks.

    -1
    InsName

    string

    No

    The instance name.

    cc-bp191w*******
    AllowChange

    integer

    No

    Specifies whether the time can be changed. Valid values:

    • 0: The time cannot be changed.

    • 1: The time can be changed.

    -1
    AllowCancel

    integer

    No

    Specifies whether the task can be canceled. Valid values:

    • 0: The task cannot be canceled.

    • 1: The task can be canceled.

    -1
    ChangeLevel

    string

    No

    The task level. Valid values:

    • all (Default): All levels.

    • S0: Returns tasks for fixing exceptions.

    • S1: Returns tasks for system O&M.

    all

    Response elements

    Element

    Type

    Description

    Example

    object

    PageNumber

    integer

    The page number.

    1
    RequestId

    string

    The request ID.

    F5178C10-1407-4987-9133-DE4DC9119F76
    PageSize

    integer

    The number of entries returned per page. Valid values:

    • 30 (Default)

    • 50

    • 100

    30
    TotalRecordCount

    integer

    The total number of records.

    1
    Items

    array<object>

    The list of O&M tasks.

    object

    The list of O&M tasks.

    Status

    integer

    The running status of the task. Return values:

    • 2: Waiting for the user to specify a time.

    • 3: To be processed.

    • 4: In progress.

    • 5: Successful.

    • 6: Failed.

    • 7: Canceled.

    2
    ChangeLevelEn

    string

    The English name of the change level.

    S1
    TaskType

    string

    The O&M event task type.

    rds_apsaradb_upgrade
    InsName

    string

    The instance ID.

    cc-bp191w*******

    Region

    string

    The region ID.

    cn-beijing
    ImpactZh

    string

    The business impact in Chinese.

    实例闪断。
    CreatedTime

    string

    The creation time. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).

    2018-05-30T14:30:00Z

    SwitchTime

    string

    The time when the backend initiates the switchover. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).

    2018-05-30T14:30:00Z

    ChangeLevelZh

    string

    The event level in Chinese.

    系统运维

    Deadline

    string

    The latest time to which the task execution time can be adjusted. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).

    2018-05-30T23:59:59Z

    PrepareInterval

    string

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

    04:00:00

    Impact

    string

    The event impact.

    TransientDisconnection

    TaskTypeZh

    string

    The task reason in Chinese.

    小版本升级

    CurrentAVZ

    string

    The current zone.

    cn-beijing-h

    AllowChange

    string

    Specifies whether the time can be changed. Return values:

    • -1: All

    • 0: No

    • 1: Yes

    -1
    DbVersion

    string

    The kernel version of the cluster.

    23.8
    ImpactEn

    string

    The event impact in English.

    Transient instance disconnection

    InsComment

    string

    The instance description.

    test
    StartTime

    string

    The time when the backend executes the task. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).

    2025-04-22T01:06Z
    ModifiedTime

    string

    The modification time. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).

    2023-11-15T06:17:54Z
    AllowCancel

    string

    Specifies whether the task can be canceled. Return values:

    • -1: All

    • 0: No

    • 1: Yes

    -1
    DbType

    string

    The database type.

    clickhouse
    ChangeLevel

    string

    The event level code.

    • S1: System O&M.

    • S0: Threat fixing.

    S1
    TaskTypeEn

    string

    The task type in English.

    Minor version update

    ResultInfo

    string

    The description of the execution result.

    userCancel
    Id

    integer

    The task ID.

    11
    SubInsNames

    array

    The sub-instance IDs.

    string

    A sub-instance ID.

    1
    TaskParams

    string

    The O&M event parameters.

    { "Action": "UpgradeDBInstance" }

    Examples

    Success response

    JSON format

    {
  "PageNumber": 1,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F76",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 2,
      "ChangeLevelEn": "S1",
      "TaskType": "rds_apsaradb_upgrade",
      "InsName": "cc-bp191w*******\n",
      "Region": "cn-beijing",
      "ImpactZh": "实例闪断。",
      "CreatedTime": "2018-05-30T14:30:00Z\n",
      "SwitchTime": "2018-05-30T14:30:00Z\n",
      "ChangeLevelZh": "系统运维\n",
      "Deadline": "2018-05-30T23:59:59Z\n",
      "PrepareInterval": "04:00:00\n",
      "Impact": "TransientDisconnection\n",
      "TaskTypeZh": "小版本升级\n",
      "CurrentAVZ": "cn-beijing-h\n",
      "AllowChange": "-1",
      "DbVersion": "23.8",
      "ImpactEn": "Transient instance disconnection\n",
      "InsComment": "test",
      "StartTime": "2025-04-22T01:06Z",
      "ModifiedTime": "2023-11-15T06:17:54Z",
      "AllowCancel": "-1",
      "DbType": "clickhouse",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update\n",
      "ResultInfo": "userCancel",
      "Id": 11,
      "SubInsNames": [
        "1"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.