All Products
Search

This Product

    AnalyticDB:DescribeMaintenanceAction

    Document Center

    AnalyticDB:DescribeMaintenanceAction

    Last Updated:Aug 28, 2026

    Queries the details of 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:DescribeMaintenanceAction

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Region

    string

    Yes

    The region ID. Valid values:

    • The ID of the region where the O&M event occurs. Example: cn-hangzhou. You can call the DescribeRegions operation to query the most recent region list.

    • You can also set Region to all to query the O&M events in all regions. If you set Region to all, you must set TaskType to all.

    cn-hangzhou
    TaskType

    string

    Yes

    The type of the O&M event. Valid values:

    • rds_apsaradb_upgrade: database software upgrades.

    • all: all the O&M events in all regions within the current account. If you set Region to all, you must set TaskType to all.

    rds_apsaradb_upgrade
    IsHistory

    integer

    No

    Specifies whether to return pending or historical O&M events. Valid values:

    • 0: returns pending O&M events.

    • 1: returns historical O&M events.

    If you do not specify this parameter, pending O&M events are returned.

    1
    PageSize

    integer

    No

    The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.

    30
    PageNumber

    integer

    No

    The page number. Pages start from page 1. Default value: 1.

    1
    RegionId

    string

    Yes

    The ID of the region where the O&M event occurs.

    Note

    You can call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    PageNumber

    integer

    The page number.

    1
    RequestId

    string

    The request ID.

    E774C8A9-8819-4A09-9E91-07C078******
    PageSize

    integer

    The number of entries per page.

    30
    TotalRecordCount

    integer

    The total number of entries returned.

    2
    Items

    array<object>

    The queried O&M events.

    object

    Status

    string

    The state of the event.

    • If you set IsHistory to 0, the state of the pending O&M event is returned. Valid values:

      • WAITING_MODIFY: The start time of the O&M event is waiting to be set.

      • WAITING: The O&M event is waiting to be processed.

      • PROCESSING: The O&M event is being processed. The switchover time of an event in this state cannot be changed.

    • If you set IsHistory to 1, the state of the historical O&M event is returned. Valid values:

      • SUCCESS: The event ended and the execution succeeded.

      • FAILED: The event ended but the execution failed.

      • CANCEL: The event was canceled.

    SUCCESS
    Deadline

    string

    The deadline before which the event can be executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-07-04T15:59:59Z
    PrepareInterval

    string

    The preparation time required before the pending O&M event can be switched. The time is in the HH:mm:ss format.

    02:00:00
    DBType

    string

    The database engine.

    analyticdb
    StartTime

    string

    The time when the task was executed in the backend. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-07-03T04:00:00Z
    TaskType

    string

    The type of the O&M event.

    rds_apsaradb_upgrade
    DBVersion

    string

    The version of the database engine.

    3.0
    DBClusterId

    string

    The cluster ID associated with the O&M event.

    am-****************
    ModifiedTime

    string

    The time when the switchover time of the O&M event was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-07-03T06:33:00Z
    Region

    string

    The ID of the region where the O&M event occurs.

    cn-hangzhou
    ResultInfo

    string

    The result of the O&M event.

    Note

    This parameter is returned only when the value of Status is FAILED or CANCEL.

    autoCancel
    CreatedTime

    string

    The time when the O&M event was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-06-30T02:44:27Z
    Id

    integer

    The ID of the O&M event.

    11111
    SwitchTime

    string

    The time when the pending O&M event is switched. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-07-03T06:00:00Z

    Examples

    Success response

    JSON format

    {
  "PageNumber": 1,
  "RequestId": "E774C8A9-8819-4A09-9E91-07C078******",
  "PageSize": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "SUCCESS",
      "Deadline": "2021-07-04T15:59:59Z",
      "PrepareInterval": "02:00:00",
      "DBType": "analyticdb",
      "StartTime": "2021-07-03T04:00:00Z",
      "TaskType": "rds_apsaradb_upgrade",
      "DBVersion": "3.0",
      "DBClusterId": "am-****************",
      "ModifiedTime": "2021-07-03T06:33:00Z",
      "Region": "cn-hangzhou",
      "ResultInfo": "autoCancel",
      "CreatedTime": "2021-06-30T02:44:27Z",
      "Id": 11111,
      "SwitchTime": "2021-07-03T06:00:00Z"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 RequiredParam.NotFound Required input param is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.