The following tables list the API operations available for use in .

Region

Operation Description
DescribeRegions Queries the available regions and zones of PolarDB .

Clusters

Type Operation Description
Cluster management CreateDBCluster Creates a PolarDB cluster.
DeleteDBCluster Deletes a specified pay-as-you-go PolarDB cluster.
DescribeDBClusters Queries PolarDB clusters under your Alibaba Cloud account or PolarDB clusters that a RAM user is authorized to access.
DescribeDBClusterAttribute Queries the details of a specified PolarDB cluster.
ModifyDBClusterMaintainTime Changes the routine maintenance window of a specified PolarDB PolarDB cluster. We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.
ModifyDBClusterDescription Changes the name of a specified PolarDB cluster to facilitate cluster maintenance.
Architecture deployment FailoverDBCluster Performs a manual switchover between the primary node and a read-only node of a specified PolarDB cluster. You can specify a read-only node as the new primary node.
ModifyDBClusterPrimaryZone Changes the primary zone of an Apsara PolarDB cluster.
Renewal management DescribeAutoRenewAttribute Queries the auto-renewal status of subscription PolarDB clusters.
ModifyAutoRenewAttribute Modifies the auto-renewal attribute for a specified subscription PolarDB cluster.
DescribeDBClusterAvailableResources Queries available resources of PolarDB clusters.

Security and encryption

Type Operation Description
Whitelist ModifyDBClusterAccessWhitelist Creates or modifies the IP address whitelist and the security groups of a specified PolarDB cluster.
DescribeDBClusterAccessWhitelist Queries the IP address whitelist and the security groups of a specified PolarDB cluster.
SSL encryption ModifyDBClusterSSL Enables or disables secure sockets layer (SSL) encryption, or updates the SSL certificate that is issued by Certificate Authorities (CA) for a specified PolarDB cluster.
DescribeDBClusterSSL Queries SSL settings of a specified PolarDB cluster.

Nodes

Operation Description
CreateDBNodes Adds a read-only node to a specified PolarDB cluster.
ModifyDBNodeClass Changes the node specifications of a specified PolarDB cluster.
RestartDBNode Restarts a node in a specified PolarDB cluster.
DeleteDBNodes Deletes one or more read-only nodes from a specified PolarDB cluster.

Cluster parameters

Operation Description
DescribeDBClusterParameters Queries the parameters of a specified PolarDB cluster.
ModifyDBClusterParameters Modifies the parameters of a specified PolarDB cluster.

Endpoints

Operation Description
CreateDBEndpointAddress Creates the public endpoint of a specified PolarDB cluster. The public endpoint can be the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
CreateDBClusterEndpoint Creates a custom cluster endpoint for a specified PolarDB cluster.
DescribeDBClusterEndpoints Queries the endpoints of a specified PolarDB cluster.
ModifyDBClusterEndpoint Modifies the attributes of a specified PolarDB cluster endpoint. For example, you can modify the read/write mode and the consistency level for the specified cluster endpoint. You can also call the operation to specify whether newly added nodes are automatically associated with the specified cluster endpoint.
ModifyDBEndpointAddress Modifies the public endpoint of a specified PolarDB cluster. The public endpoint can be the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
DeleteDBEndpointAddress Releases the public endpoint of a specified PolarDB cluster. The public endpoint can be the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
DeleteDBClusterEndpoint Releases a custom cluster endpoint of a specified PolarDB cluster.

Logs

Operation Description
DescribeSlowLogRecords Queries the details about the slow query logs of a specified PolarDB cluster.
DescribeDBClusterAuditLogCollector Queries whether SQL data collector is enabled for a specified PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.
ModifyDBClusterAuditLogCollector Enables or disables SQL data collector for a specified PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.

Account management

Operation Description
CreateAccount Creates a database account for a specified PolarDB cluster.
DescribeAccounts Queries the information about a database account for a specified PolarDB cluster.
ModifyAccountDescription Modifies the description of a database account for a specified PolarDB cluster.
ModifyAccountPassword Changes the password of a database account for a specified PolarDB cluster.
GrantAccountPrivilege Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.
RevokeAccountPrivilege Revokes the access permissions on one or more databases from a specified PolarDB standard account.
ResetAccount Resets the privileges of a privileged account for a specified PolarDB cluster.
DeleteAccount Deletes a specified PolarDB database account.

Database management

Operation Description
CreateDatabase Creates a database for a specified PolarDB cluster.
DescribeDatabases Queries the databases of a specified PolarDB cluster.
ModifyDBDescription Modifies the description for a specified PolarDB cluster.
DeleteDatabase Deletes a database from a specified PolarDB cluster.

Backups

Type Operation Description
Backup management CreateBackup Manually creates a full snapshot backup for a specified PolarDB cluster.
DescribeBackups Queries the backup information about a specified PolarDB cluster.
DescribeBackupTasks Queries the backup tasks of a specified PolarDB cluster.
DescribeBackupLogs Queries backup logs and the URLs for downloading backup logs for a specified PolarDB cluster.
DescribeDetachedBackups Queries the backup set details of a PolarDB cluster that has been deleted.
DescribeDBClustersWithBackups Queries the details about the PolarDB clusters that contain backup sets and reside in a specified region.
DeleteBackup Deletes the backups of a specified PolarDB cluster.
Backup policy DescribeBackupPolicy Queries the automatic backup policy of a PolarDB cluster.
DescribeLogBackupPolicy Queries the retention policy of log backups in a PolarDB cluster.
ModifyBackupPolicy Modifies the automatic backup policy of a specified PolarDB cluster.
ModifyLogBackupPolicy Modifies the retention policy of log backups for a PolarDB cluster.

Data migration from ApsaraDB RDS for MySQL

Operation Description
DescribeDBClusterMigration Queries the data migration status of a specified PolarDB cluster.
ModifyDBClusterMigration Migrates data from an existing ApsaraDB RDS for MySQL instance to a PolarDB cluster, or rolls back data migration.
CloseDBClusterMigration Cancels or completes a data migration task for a specified PolarDB cluster.

Tags

Operation Description
TagResources Attaches tags to one or more PolarDB clusters.
UntagResources Detaches tags from one or more PolarDB clusters.
ListTagResources Queries the tags that are attached to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are attached.

Pending events

Operation Description
DescribePendingMaintenanceAction Queries the details of pending events.
DescribePendingMaintenanceActions Queries the number of pending events for different task types.
ModifyPendingMaintenanceAction Changes the task switch time of pending events.

Monitoring

Operation Description
DescribeDBNodePerformance Queries the performance data of a specified PolarDB cluster node.
DescribeDBClusterPerformance Queries the performance data of a specified PolarDB cluster.
DescribeDBClusterMonitor Queries the interval at which the monitoring data of a specified PolarDB cluster is collected.
ModifyDBClusterMonitor Changes the interval at which the monitoring data of a specified PolarDB cluster is collected.