All Products
Document Center

ApsaraDB for MongoDB:DescribeActiveOperationTaskType

Last Updated:Jan 17, 2023

Queries the types of O\\\\\\&M tasks on an ApsaraDB for MongoDB instance and the number and details of tasks of each type.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:DescribeActiveOperationTaskType READ
  • MongoDB

Request parameters

Parameter Type Required Description Example
IsHistory integer No

Specifies whether to return all O&M tasks. Valid values:

  • 0: returns only pending tasks.
  • 1: returns all tasks.

Default value: 0.

ResourceGroupId string No

The ID of the resource group.


Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.

TypeList array

The list of tasks.

TaskType string

The type of the task. Valid values:

  • rds_apsaradb_transfer: instance migration
  • rds_apsaradb_upgrade: minor version update
TaskTypeInfoEn string

The task type (English).

TaskTypeInfoZh string

The task type (Chinese).

Count integer

The number of pending tasks.



Normal return example


  "RequestId": "C7EE83BF-7BA8-5087-BAC9-ED85ED54****",
  "TypeList": [
      "TaskType": "rds_apsaradb_upgrade",
      "TaskTypeInfoEn": "rds_apsaradb_upgrade",
      "TaskTypeInfoZh": "rds_apsaradb_upgrade",
      "Count": 1

Error codes

Http code Error code Error message
400 RequiredParam.NotFound Required input param is not found.

For a list of error codes, visit the API error center.