DescribeMaintenanceAction - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about O\&M events.

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
adb:DescribeMaintenanceAction	get	All Resources *	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 the information about pending or historical O&M events. Valid values: 0: returns the information about pending O&M event. 1: returns the information about historical O&M event. If you do not specify this parameter, the information about pending O&M event 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 parameters

Parameter	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 that is 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 ID of the cluster that is involved in the O&M event.	am-****************
ModifiedTime	string	The point in time at which the switchover time of the O&M event was 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 execution 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

Sample success responses

JSONformat

{
  "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
400	RequiredParam.NotFound	Required input param is not found.

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