All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeActiveOperationTaskType

Last Updated:Mar 15, 2024

Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB for MongoDB instance.

Operation description

This operation is no longer updated and will be unavailable.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeActiveOperationTaskTypeREAD
  • DBInstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IsHistoryintegerNo

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

  • 0 (default): The system returns only pending O&M tasks.
  • 1: The system returns historical O&M tasks.
0
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeSecurityGroupConfiguration operation to query the resource group ID.

rg-acfmyiu4ekp****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

C7EE83BF-7BA8-5087-BAC9-ED85ED54****
TypeListobject []

The O&M tasks.

TaskTypestring

The type of the task. Valid values:

  • **rds_apsaradb_transfer**: data migration
  • **rds_apsaradb_upgrade**: minor version update
rds_apsaradb_upgrade
TaskTypeInfoEnstring

The task type in English.

rds_apsaradb_upgrade
TaskTypeInfoZhstring

The task type in Chinese.

rds_apsaradb_upgrade
Countinteger

The number of pending tasks.

1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400RequiredParam.NotFoundRequired input param is not found.

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

Change history

Change timeSummary of changesOperation
No change history