Query Active O&M Tasks with DescribeActiveOperationTasks - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Retrieves O&M events.

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

adb:DescribeActiveOperationTasks

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shenzhen
Region	string	No	The region information.	cn-shenzhen
TaskType	string	No	The task type. A value of all indicates that all tasks of the user are queried. Set this parameter to all.	all
PageSize	integer	No	The number of entries per page. Default value: 25.	25
PageNumber	integer	No	The page number. The value must be greater than 0. Default value: 1.	1
ProductId	string	No	The product ID.	ads
DbType	string	No	The database type.	analyticdb
Status	integer	No	The task status. Valid values: -1: all pending and running tasks 3: pending 4: running	-1
InsName	string	No	The instance name.	am-2ze307ym37t762hnl
AllowChange	integer	No	Specifies whether the time can be modified. Valid values: -1: The time of all O&M events can be modified. 0: The time cannot be modified. 1: The time can be modified.	-1
AllowCancel	integer	No	Specifies whether cancellation is allowed. Valid values: -1: All O&M events can be canceled. 0: Cancellation is not allowed. 1: Cancellation is allowed.	-1
ChangeLevel	string	No	The change level. Default value: all. Valid values: all: all levels including exception fix and system maintenance S0: exception fix S1: system maintenance	all

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	421794A3-72A5-5D27-9E8B-A75A4C503E17
PageNumber	integer	The page number.	12
PageSize	integer	The number of entries per page.	10
TotalRecordCount	integer	The total number of records.	20
Items	array<object>	The list of parameters.
	object	The list of parameters.
Status	integer	The status. Valid values: 3: pending 4: running	3
ChangeLevelEn	string	The change level in English.	Risk repairment
TaskType	string	The task type.	rds_apsaradb_upgrade
InsName	string	The cluster name.	am-2ze307ym37t762hnl
Region	string	The region.	cn-hangzhou
ImpactZh	string	The impact description in Chinese.	实例闪断,小版本号更新
CreatedTime	string	The creation time.	2021-06-15T16:00:00Z
SwitchTime	string	The switchover time.	2021-06-15T16:00:00Z
ChangeLevelZh	string	The change level in Chinese.	系统维护
Deadline	string	The deadline.	2021-06-15T16:00:00Z
PrepareInterval	string	The preparation interval.	03:00:00
Impact	string	The impact.	TransientDisconnectionAndMinorVersionUpgrade
TaskTypeZh	string	The task type in Chinese.	小版本升级
CurrentAVZ	string	The current availability zone (AVZ).	cn-beijing-k
AllowChange	string	Indicates whether modification is allowed. Valid values: 0: Not allowed. 1: Allowed.	0
DbVersion	string	The database version.	3.0
ImpactEn	string	The impact description in English.	Transient instance disconnection, minor version upgrade
InsComment	string	The description.	xxx
StartTime	string	The start time.	2021-06-15T16:00:00Z
ModifiedTime	string	The modification time.	2021-06-15T16:00:00Z
AllowCancel	string	Indicates whether cancellation is allowed. Valid values: 0: Not allowed. 1: Allowed.	1
DbType	string	The database type.	analyticdb
ChangeLevel	string	The change level.	all
TaskTypeEn	string	The task type in English.	Minor version update
ResultInfo	string	The result information.	xxx
Id	integer	The task ID.	2389899
SubInsNames	array	The list of child instances.
	string	The child instance ID.	am-xxxxxx
TaskParams	string	The task parameters.	{\"outer_user_params\":{\"TargetMinorVersion\":\"3.2.2.6\",\"detailCode\":\"OldKernelVersionUpgrade\",\"cancelCode\":\"OutOfNewFeatureAndStability\"},\"params\":{},\"internal_params\":{\"instanceInfo\":[],\"destHostInfo\":[]}}

Examples

Success response

JSON format

{
  "RequestId": "421794A3-72A5-5D27-9E8B-A75A4C503E17",
  "PageNumber": 12,
  "PageSize": 10,
  "TotalRecordCount": 20,
  "Items": [
    {
      "Status": 3,
      "ChangeLevelEn": "Risk repairment",
      "TaskType": "rds_apsaradb_upgrade",
      "InsName": "am-2ze307ym37t762hnl",
      "Region": "cn-hangzhou",
      "ImpactZh": "Service interruption and minor version update",
      "CreatedTime": "2021-06-15T16:00:00Z",
      "SwitchTime": "2021-06-15T16:00:00Z",
      "ChangeLevelZh": "System maintenance",
      "Deadline": "2021-06-15T16:00:00Z",
      "PrepareInterval": "03:00:00",
      "Impact": "TransientDisconnectionAndMinorVersionUpgrade",
      "TaskTypeZh": "Minor version update",
      "CurrentAVZ": "cn-beijing-k",
      "AllowChange": "0",
      "DbVersion": "3.0",
      "ImpactEn": "Transient instance disconnection, minor version upgrade",
      "InsComment": "xxx",
      "StartTime": "2021-06-15T16:00:00Z",
      "ModifiedTime": "2021-06-15T16:00:00Z",
      "AllowCancel": "1",
      "DbType": "analyticdb",
      "ChangeLevel": "all",
      "TaskTypeEn": "Minor version update",
      "ResultInfo": "xxx",
      "Id": 2389899,
      "SubInsNames": [
        "am-xxxxxx"
      ],
      "TaskParams": "{\\\"outer_user_params\\\":{\\\"TargetMinorVersion\\\":\\\"3.2.2.6\\\",\\\"detailCode\\\":\\\"OldKernelVersionUpgrade\\\",\\\"cancelCode\\\":\\\"OutOfNewFeatureAndStability\\\"},\\\"params\\\":{},\\\"internal_params\\\":{\\\"instanceInfo\\\":[],\\\"destHostInfo\\\":[]}}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.