provides the following API operations.

Regions

API Description
DescribeRegions Queries the regions and the zones that PolarDB supports.

Clusters

Category API Description
Cluster management CreateDBCluster Creates a PolarDB cluster.
DeleteDBCluster Releases a specified pay-as-you-go PolarDB cluster.
DescribeDBClusters Queries the PolarDB cluster list or the PolarDB clusters that a RAM user is authorized to access.
DescribeDBClusterAttribute Queries the detailed attributes of a specified PolarDB cluster.
ModifyDBClusterMaintainTime Changes the routine maintenance window of a specified PolarDB cluster. Generally, the routine maintenance window is set to off-peak hours. Alibaba Cloud maintains your cluster in the specified maintenance window to minimize the impacts on your business.
ModifyDBClusterDescription Changes the name of a specified PolarDB cluster to facilitate cluster maintenance.
DescribeTasks Queries the progress details of the tasks (such as creating a cluster) that are generated based on API operations.
Architecture deployment ModifyDBClusterPrimaryZone Changes the primary zone of a specified PolarDB cluster.
FailoverDBCluster Performs 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.
DescribeGlobalDatabaseNetworks Views the details about all the global database networks (GDNs) under an account.
Renewal management DescribeAutoRenewAttribute Queries the auto-renewal status of subscription PolarDB clusters.
ModifyAutoRenewAttribute Specifies the auto-renewal attribute for a specified subscription PolarDB cluster.
DescribeDBClusterAvailableResources Queries available resources of PolarDB clusters.

Kernel

API Description
DescribeDBClusterVersion Queries the details about the current kernel version of a specified cluster.

Data security

Category API Description
Whitelist ModifyDBClusterAccessWhitelist Creates or modifies the whitelist (the IP whitelist and security groups) of a specified PolarDB cluster.
DescribeDBClusterAccessWhitelist Queries the IP whitelist and the security groups of a specified PolarDB cluster that can be accessed.
SSL encryption ModifyDBClusterSSL Enables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB cluster.
DescribeDBClusterSSL Queries the SSL settings of a specified PolarDB cluster.
TDE DescribeDBClusterTDE Queries the details about the transparent data encryption (TDE) settings of a specified PolarDB cluster.
ModifyDBClusterTDE Enables the TDE feature or modifies the encryption method for a specified cluster.

Nodes

API 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 read-only nodes from a specified PolarDB cluster.

Cluster parameters

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

Endpoints

API 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 endpoint information about a specified PolarDB cluster.
ModifyDBClusterEndpoint Modifies the attributes of a specified PolarDB cluster endpoint, such as the read/write mode and the consistency level. You can also 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

API 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.

Accounts

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

Databases

API Description
CreateDatabase Creates a database of a specified PolarDB cluster.
DescribeDatabases Queries the database list information about a specified PolarDB cluster.
ModifyDBDescription Modifies the description or the remarks of a specified PolarDB database.
DeleteDatabase Deletes a database from a specified PolarDB cluster.

Backups

Category API 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 task list of a specified PolarDB cluster.
DescribeBackupLogs Queries the backup log list and the URLs for downloading backup logs.
DescribeDetachedBackups Queries the backup set information about a PolarDB cluster that has been released.
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.
DescribeLogBackupPolicy Queries the retention policy for log backups in a specified PolarDB cluster.
ModifyBackupPolicy Modifies the automatic backup policy.
ModifyLogBackupPolicy Modifies the retention policy for log backups in a specified PolarDB cluster.

Data migration from ApsaraDB RDS for MySQL

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

Tags

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

Pending events

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

Monitoring

API 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 frequency at which the monitoring data of a specified PolarDB cluster is collected.
ModifyDBClusterMonitor Changes the frequency at which the monitoring data of a specified PolarDB cluster is collected.