DescribeActiveOperationTasks API Overview - ApsaraDB for ClickHouse

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 RAM authorization is required for this operation. If you encounter permission issues, 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 per 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 to filter by. Valid values: -1 (all tasks), 3 (to be processed), 4 (in progress), 5 (successful), 6 (failed), 7 (canceled).	-1
InsName	string	No	The instance name.	cc-bp191w*******
AllowChange	integer	No	Filters tasks by whether the scheduled time can be changed. Valid values: 0 (time cannot be changed), 1 (time can be changed).	-1
AllowCancel	integer	No	Filters tasks by whether the task can be canceled. Valid values: 0 (task cannot be canceled), 1 (task can be canceled).	-1
ChangeLevel	string	No	The task change level. Valid values: all (default, all levels), S0 (exception fixing), S1 (system O&M).	all

Response elements

Element	Type	Description	Example
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F76
PageSize	integer	The number of entries 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.
Items[].Id	integer	The task ID.	11
Items[].InsName	string	The instance ID.	cc-bp191w*******
Items[].Region	string	The region ID.	cn-beijing
Items[].DbType	string	The database type.	clickhouse
Items[].DbVersion	string	The kernel version of the cluster.	23.8
Items[].CurrentAVZ	string	The zone where the instance currently resides.	cn-beijing-h
Items[].InsComment	string	The instance description.	test
Items[].Status	integer	The task status. Valid values: 2 (waiting for the user to set a time), 3 (to be processed), 4 (in progress), 5 (successful), 6 (failed), 7 (canceled).	2
Items[].TaskType	string	The O&M task type.	rds_apsaradb_upgrade
Items[].TaskTypeEn	string	The O&M task type in English.	Minor version update
Items[].TaskTypeZh	string	The O&M task type in Chinese.	minor version upgrade
Items[].TaskParams	string	The O&M task parameters in JSON format.	{ "Action": "UpgradeDBInstance" }
Items[].ChangeLevel	string	The change level code. Valid values: S0 (Threat fixing), S1 (system O&M).	S1
Items[].ChangeLevelEn	string	The change level in English.	S1
Items[].ChangeLevelZh	string	The change level in Chinese.	system maintenance
Items[].Impact	string	The event impact code.	TransientDisconnection
Items[].ImpactEn	string	The event impact in English.	Transient instance disconnection
Items[].ImpactZh	string	The event impact in Chinese.	instance-interruption。
Items[].AllowChange	string	Whether the scheduled time can be changed. Valid values: -1 (all), 0 (no), 1 (yes).	-1
Items[].AllowCancel	string	Whether the task can be canceled. Valid values: -1 (all), 0 (no), 1 (yes).	-1
Items[].CreatedTime	string	The time when the task was created, in UTC (YYYY-MM-DDTHH:mm:ssZ).	2018-05-30T14:30:00Z
Items[].StartTime	string	The time when the backend starts executing the task, in UTC (YYYY-MM-DDTHH:mm:ssZ).	2025-04-22T01:06Z
Items[].SwitchTime	string	The time when the backend initiates the switchover, in UTC (YYYY-MM-DDTHH:mm:ssZ).	2018-05-30T14:30:00Z
Items[].Deadline	string	The latest time to which the task execution time can be adjusted, in UTC (YYYY-MM-DDTHH:mm:ssZ).	2018-05-30T23:59:59Z
Items[].ModifiedTime	string	The time when the task was last modified, in UTC (YYYY-MM-DDTHH:mm:ssZ).	2023-11-15T06:17:54Z
Items[].PrepareInterval	string	The preparation time required before the switchover, in HH:mm:ss format.	04:00:00
Items[].ResultInfo	string	The description of the task execution result.	userCancel
Items[].SubInsNames	array	The IDs of sub-instances associated with the task.
Items[].SubInsNames[]	string	A sub-instance ID.	1

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*******",
      "Region": "cn-beijing",
      "ImpactZh": "instance-interruption。",
      "CreatedTime": "2018-05-30T14:30:00Z",
      "SwitchTime": "2018-05-30T14:30:00Z",
      "ChangeLevelZh": "system maintenance",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00",
      "Impact": "TransientDisconnection",
      "TaskTypeZh": "minor version upgrade",
      "CurrentAVZ": "cn-beijing-h",
      "AllowChange": "-1",
      "DbVersion": "23.8",
      "ImpactEn": "Transient instance disconnection",
      "InsComment": "test",
      "StartTime": "2025-04-22T01:06Z",
      "ModifiedTime": "2023-11-15T06:17:54Z",
      "AllowCancel": "-1",
      "DbType": "clickhouse",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update",
      "ResultInfo": "userCancel",
      "Id": 11,
      "SubInsNames": [
        "1"
      ],
      "TaskParams": "{\"Action\": \"UpgradeDBInstance\"}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.