DescribeActiveOperationTasks - - Alibaba Cloud Documentation Center

Queries the details about the O\\\&M tasks of an ApsaraDB for Redis instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeActiveOperationTasks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region ID of the O&M task. You can call the DescribeRegions operation to query the most recent region list. Note A value of all indicates all region IDs.	cn-shanghai
TaskType	string	No	The type of the O&M task. If left blank, all types will be queried. Enumeration Value: rds_apsradb_upgrade: 小版本升级. rds_apsaradb_ha: 主备切换. rds_apsaradb_ssl_update: SSL证书更新. rds_apsaradb_major_upgrade: 大版本升级. rds_apsradb_transfer: 实例迁移. rds_apsaradb_network_upgrade: 网络升级. rds_apsaradb_modify_config: 实例参数调整. rds_apsaradb_maxscale: 代理小版本升级.	all
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 name of the service. Valid values: RDS, POLARDB, MongoDB, and Redis. For Redis instances, set the value to Redis.	Redis
DbType	string	No	The database type. Valid values: redis	redis
Status	integer	No	The status of operation and maintenance events. It is used to filter and return tasks. The values are as follows:. Valid values: -1: All events. 3: Events awaiting processing. 4: Events being processed. 5: Events that have successfully ended. 6: Events that have ended in failure. 7: Events that have been canceled.	3
InsName	string	No	The name of the instance. You can leave this parameter empty. If you configure this parameter, you can specify the name only of one instance.	r-wz96fzmpvpr2qnqnlb
AllowChange	integer	No	The filter condition that is used to return tasks based on the settings of the switching time. Default value: -1. Valid values: -1: returns all tasks. 0: returns only tasks for which the switching time cannot be changed. 1: returns only tasks for which the switching time can be changed.	-1
AllowCancel	integer	No	The filter condition that is used to return tasks based on the settings of task cancellation. Default value: -1. Valid values: -1: returns all tasks. 0: returns only tasks that cannot be canceled. 1: returns only tasks 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 parameters

Parameter	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 returned per page. Default 25.	25
TotalRecordCount	integer	The total number of returned entries.	1
Items	array<object>	The list of details of O&M tasks.
Items	object	Details of O&M tasks.
Status	integer	The status of operation and maintenance events. Return values 3: Events awaiting processing. 4: Events being processed. 5: Events that have successfully ended. 6: Events that have ended in failure. 7: Events that have been canceled.	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 ID of the instance.	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. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-05-30T14:30:00Z
SwitchTime	string	The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-05-30T14:30:00Z
ChangeLevelZh	string	The level of the task in Chinese.
Deadline	string	The deadline before which the time to preform the O&M task can be modified. The time in UTC is displayed in the yyyy-MM-ddTHH:mm:ssZ format.	2018-05-30T23:59:59Z
PrepareInterval	string	The required preparation period between the task start time and the switchover time. The time is displayed 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. The value 1 indicates that the switching time can be changed. The value 0 indicates that the switching time cannot be changed.	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 time when the O&M task was preformed. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-05-30T00:00:00Z
ModifiedTime	string	The time when the O&M task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-05-30T14:30:00Z
AllowCancel	string	Indicates whether the task can be canceled. The value 1 indicates that the task can be canceled. The value 0 indicates that the task cannot be canceled.	1
DbType	string	The database type of the instance. The return value is Redis.	redis
ChangeLevel	string	The code of the task level. The value S1 indicates the system O&M level. The value S0 indicates the exception fixing level.	S1
TaskTypeEn	string	The reason for the task in English.	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 the subinstances.
SubInsNames	string	The name of the subinstance.	sub1369716295573-tes2cy6**.2013052818**
TaskParams	string	The parameters of the task.	{ "Action": "UpgradeDBInstance" }
Impact	string	The impact of the task.	TransientDisconnection

Examples

Sample success responses

JSONformat

{
  "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": "",
      "CreatedTime": "2018-05-30T14:30:00Z\n",
      "SwitchTime": "2018-05-30T14:30:00Z\n",
      "ChangeLevelZh": "",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00\n",
      "TaskTypeZh": "",
      "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history