PolarDB:DescribePendingMaintenanceAction - PolarDB - Alibaba Cloud - PolarDB

Queries the information about a pending event.

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

polardb:DescribePendingMaintenanceAction

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region ID of the pending event. You can call the DescribeRegions operation to query the regions and zones that are supported by PolarDB. Note You can set this parameter to all to view all pending events within your account. If you set `Region` to all, you must set `TaskType` to all.	all
TaskType	string	Yes	The task type of pending events. Valid values: DatabaseSoftwareUpgrading: database software upgrades DatabaseHardwareMaintenance: hardware maintenance and upgrades DatabaseStorageUpgrading: database storage upgrades DatabaseProxyUpgrading: minor version upgrades of the proxy all: returns pending events of all preceding types. Note If the `Region` parameter is set to all, the `TaskType` parameter must be set to all.	all
IsHistory	integer	No	Specifies whether to return the historical tasks. Valid values: 0: returns the current task. 1: returns the historical tasks. Default value: 0.	0
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The number of the page to return. Specify the parameter to a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-************

Response elements

Element	Type	Description	Example
	object
TotalRecordCount	integer	The total number of returned entries.	1
RequestId	string	The ID of the request.	2F029645-FED9-4FE8-A6D3-488954******
PageSize	integer	The number of entries per page.	30
PageNumber	integer	The page number.	1
Items	array<object>	Details about tasks.
	object
Status	integer	The status of the pending task. If you set the `IsHistory` parameter to 0, the status of the pending task is returned. Valid values: 2: The start time of the task is to be specified. 3: The task is pending. 4: The task is running. In this case, you cannot modify the execution time. If you set the `IsHistory` parameter to 1, the details of the historical tasks are returned. Valid values: 5: The task is completed and executed. 6: The task is completed but fails to be executed. 7: The task is canceled.	3
PrepareInterval	string	The preparation time that is required before the pending event is switched. The time follows the `HH:mm:ss` format.	04:00:00
Deadline	string	The deadline before which the task can be executed. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-06-11T15:59:59Z
DBType	string	The type of the database engine. Valid values: MySQL PostgreSQL Oracle	MySQL
TaskType	string	The type of the pending event.	DatabaseSoftwareUpgrading
StartTime	string	The time when the task was executed in the background. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-06-09T18:00:00Z
DBVersion	string	The version of the database engine. Valid values for the MySQL database engine: 5.6 5.7 8.0 Valid values for the PostgreSQL database engine: 11 14 Valid value for the Oracle database engine: 11	8.0
ModifiedTime	string	The time when the parameter was modified. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-06-09T22:00:42Z
DBClusterId	string	The ID of the cluster.	pc-************
Region	string	The region ID of the pending event.	cn-hangzhou
ResultInfo	string	The execution result of the task. Valid values: manualCancel: The task is manually canceled. paramCheckNotPass: The task fails to pass the parameter check. Note This parameter is returned only when the value of the `Status` parameter is 6 or 7. The value 6 indicates that the task is completed but fails to be executed. The value 7 indicates that the task is canceled.	manualCancel
CreatedTime	string	The time when the task was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-06-09T22:00:42Z
Id	integer	The ID of the task.	111111
SwitchTime	string	The time when the pending event was switched. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-06-09T22:00:00Z

Examples

Success response

JSON format

{
  "TotalRecordCount": 1,
  "RequestId": "2F029645-FED9-4FE8-A6D3-488954******",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 3,
      "PrepareInterval": "04:00:00",
      "Deadline": "2020-06-11T15:59:59Z",
      "DBType": "MySQL",
      "TaskType": "DatabaseSoftwareUpgrading",
      "StartTime": "2020-06-09T18:00:00Z",
      "DBVersion": "8.0",
      "ModifiedTime": "2020-06-09T22:00:42Z",
      "DBClusterId": "pc-************",
      "Region": "cn-hangzhou",
      "ResultInfo": "manualCancel",
      "CreatedTime": "2020-06-09T22:00:42Z",
      "Id": 111111,
      "SwitchTime": "2020-06-09T22:00:00Z"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	RequiredParam.NotFound	Required input param is not found.	The specified parameter does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.