DescribeActiveOperationTasks - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the scheduled O\\\&M tasks of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
dds:DescribeActiveOperationTasks	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region ID of the instance. Note If you set the Region parameter to all, all tasks created within your Alibaba Cloud account are queried. In this case, you must set the taskType parameter to all.	cn-beijing
TaskType	string	No	The task type.	***
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The page number of the page to return.	1
ProductId	string	No	The ID of the service.	***
DbType	string	No	The type of the database engine.	***
Status	integer	No	The status of the task. Valid values: 0: waiting for execution 1: being executed 2: successful 3: failed	0
InsName	string	No	The name of the instance.	dds-bp16aaccfe10e3e4
AllowChange	integer	No	Specifies whether to allow the modification operation. Valid values: 0: The modification operation is not allowed. 1: The modification operation is allowed.	-1
AllowCancel	integer	No	Specifies whether to allow the cancellation operation. Valid values: 0: The cancellation operation is not allowed. 1: The cancellation operation is allowed.	***
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.	***

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The number of the returned page.	1
RequestId	string	The request ID.	111E7B16-0A87-4CBA-B271-F34AD61E099F
PageSize	integer	The number of entries returned per page.	30
TotalRecordCount	integer	The total number of returned entries.	727
Items	array<object>	The O&M tasks.
	object	The list of O&M tasks.
Status	integer	N/A	***
ChangeLevelEn	string	N/A	***
TaskType	string	The task type.	***
InsName	string	The ID of the node.	***
Region	string	The region of the instance.	cn-hangzhou
ImpactZh	string	N/A	***
CreatedTime	string	The time when the task was created.	2021-07-14 10:48:43
SwitchTime	string	The switchover point in time in which disconnection may occur. The time follows the ISO 8601 standard in the yyyy-mm-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-11-24T11:20:00Z
ChangeLevelZh	string	The task type in English.	***
Deadline	string	The end time of the O&M task.	1646014421633
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.	***
TaskTypeZh	string	The task type in Chinese.	***
CurrentAVZ	string	N/A	***
AllowChange	string	Indicates whether the modification operation is allowed. 0: The modification operation is not allowed. 1: The modification operation is allowed.	0
DbVersion	string	The version of the database engine.	5.6
ImpactEn	string	N/A	***
InsComment	string	The description of the instance.	***
StartTime	string	The start time of the task. The time follows the ISO 8601 standard in the yyyy-mm-dd Thh:mm:ssZ format. The time is displayed in UTC.	2022-12-24T06:01:05Z
ModifiedTime	string	The time when the task is modified. The time follows the ISO 8601 standard in the yyyy-mm-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-12-24T09:48:01Z
AllowCancel	string	N/A	***
DbType	string	The type of the database engine.	mongoDb
ChangeLevel	string	The change level of the O&M task.	***
TaskTypeEn	string	N/A	***
ResultInfo	string	The result information. The value of this parameter can be ignored.	***
Id	integer	The task ID.	***
SubInsNames	array	The subinstances.
	string	The name of the subinstance.	***

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "PageSize": 30,
  "TotalRecordCount": 727,
  "Items": [
    {
      "Status": 0,
      "ChangeLevelEn": "***",
      "TaskType": "***",
      "InsName": "***",
      "Region": "cn-hangzhou",
      "ImpactZh": "***",
      "CreatedTime": "2021-07-14 10:48:43",
      "SwitchTime": "2022-11-24T11:20:00Z",
      "ChangeLevelZh": "***",
      "Deadline": "1646014421633",
      "PrepareInterval": "***",
      "TaskTypeZh": "***",
      "CurrentAVZ": "***",
      "AllowChange": "0",
      "DbVersion": "5.6",
      "ImpactEn": "***",
      "InsComment": "***",
      "StartTime": "2022-12-24T06:01:05Z",
      "ModifiedTime": "2022-12-24T09:48:01Z",
      "AllowCancel": "***",
      "DbType": "mongoDb",
      "ChangeLevel": "***",
      "TaskTypeEn": "***",
      "ResultInfo": "***",
      "Id": 0,
      "SubInsNames": [
        "***"
      ]
    }
  ]
}

Error codes

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