All Products
Search
Document Center

PolarDB:DescribePendingMaintenanceActions

Last Updated:Jun 17, 2024

Queries the numbers of pending events of different task types.

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
polardb:DescribePendingMaintenanceActionsRead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
IsHistoryintegerNo

Specifies whether to return the historical tasks. Valid values:

  • 0: returns the current task.
  • 1: returns the historical tasks.

Default value: 0.

1
ResourceGroupIdstringNo

The ID of the resource group.

rg-************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

314127C2-B6C1-4F58-B1F6-E6B645******
TypeListobject []

The details of pending events.

TaskTypestring

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
DatabaseSoftwareUpgrading
Countinteger

The number of pending events.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "314127C2-B6C1-4F58-B1F6-E6B645******",
  "TypeList": [
    {
      "TaskType": "DatabaseSoftwareUpgrading",
      "Count": 1
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RequiredParam.NotFoundRequired input param is not found.The specified parameter does not exist.

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