Queries the information about a pending event.
Debugging
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 |
---|---|---|---|---|
polardb:DescribePendingMaintenanceAction | Read |
|
| 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
Region to all, you must set TaskType to all. | all |
TaskType | string | Yes | The task type of pending events. Valid values:
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:
Default value: 0. | 0 |
PageSize | integer | No | The number of entries per page. Valid values: 30, 50, or 100. Default value: 30. | 30 |
PageNumber | integer | No | The page number. The value of this parameter must be an integer that is greater than 0. Default value: 1. | 1 |
ResourceGroupId | string | No | The ID of the resource group. | rg-************ |
Response parameters
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.