PolarDB provides the following API operations.

Regions

APIDescription
DescribeRegionsQueries the regions and the zones that are supported by PolarDB.

Clusters

CategoryAPIDescription
Cluster managementCreateDBClusterCreates a PolarDB cluster.
DeleteDBClusterReleases a specified pay-as-you-go PolarDB cluster.
DescribeDBClustersQueries PolarDB clusters or the clusters that a RAM user is authorized to access.
DescribeDBClusterAttribute Queries the detailed attributes of a specified PolarDB cluster.
ModifyDBClusterMaintainTimeChanges the maintenance window of a specified PolarDB cluster. In most cases, the 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.
ModifyDBClusterDescriptionChanges the name of a specified PolarDB cluster to facilitate cluster maintenance.
DescribeTasksQueries the progress details about the tasks (such as creating a cluster) that are generated by using API operations.
Architecture deploymentModifyDBClusterPrimaryZoneChanges the primary zone of a specified PolarDB cluster.
FailoverDBClusterManually switches 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.
Renewal managementDescribeAutoRenewAttributeQueries the auto-renewal status of a specified PolarDB cluster that uses the subscription billing method.
ModifyAutoRenewAttributeConfigures auto-renewal for a specified PolarDB cluster that uses the subscription billing method.
DescribeDBClusterAvailableResourcesQueries available resources for a specified PolarDB cluster.

Data security

CategoryAPIDescription
WhitelistModifyDBClusterAccessWhitelistCreates or modifies the whitelists (the IP whitelists and security groups) of a specified PolarDB cluster.
DescribeDBClusterAccessWhitelistQueries the IP whitelists and the security groups of a specified PolarDB cluster that can be accessed.
SSL encryptionModifyDBClusterSSLEnables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB cluster.
DescribeDBClusterSSLQueries the SSL settings of a specified PolarDB cluster.

Nodes

APIDescription
CreateDBNodesAdds a read-only node to a specified PolarDB cluster.
ModifyDBNodeClassChanges the node specifications of a specified PolarDB cluster.
RestartDBNodeRestarts a node in a specified PolarDB cluster.
DeleteDBNodesDeletes read-only nodes in a specified PolarDB cluster.

Cluster parameters

APIDescription
DescribeDBClusterParametersQueries the parameters of a specified PolarDB cluster.
ModifyDBClusterParametersModifies the parameters of a specified PolarDB cluster or applies a parameter template to the cluster.

Endpoints

APIDescription
CreateDBEndpointAddressCreates 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.
CreateDBClusterEndpointCreates a custom cluster endpoint for a specified PolarDB cluster.
DescribeDBClusterEndpointsQueries the information about the endpoints of a specified PolarDB cluster.
ModifyDBClusterEndpointModifies the endpoint attributes of a specified PolarDB cluster, 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.
ModifyDBEndpointAddressModifies 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.
DeleteDBEndpointAddressReleases 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.
DeleteDBClusterEndpointReleases a custom cluster endpoint of a specified PolarDB cluster.

Logs

APIDescription
DescribeDBClusterAuditLogCollectorQueries whether SQL data collector is enabled for a specified PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.
ModifyDBClusterAuditLogCollectorEnables or disables SQL data collector for a specified PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.

Accounts

APIDescription
CreateAccountCreates an account for a specified PolarDB database.
DescribeAccountsQueries the information about a database account for a specified PolarDB cluster.
CheckAccountNameChecks whether a specified account name is valid or whether an account that has the same name as the specified account already exists in the current cluster.
ModifyAccountDescriptionModifies the remarks of a specified PolarDB database account.
ModifyAccountPasswordChanges the password of a specified PolarDB database account.
DeleteAccountDeletes a specified PolarDB database account.

Databases

APIDescription
CreateDatabaseCreates a database in a specified PolarDB cluster.
DescribeDatabasesQueries the databases in a specified PolarDB cluster.
DeleteDatabaseDeletes a database in a specified PolarDB cluster.
DescribeDBInitializeVariableQueries the attributes of a specified PolarDB for PostgreSQL(Compatible with Oracle) database, such as supported character sets and collations.
CheckDBNameChecks whether a specified database name is valid or whether a database that has the same name as the specified database already exists in the current cluster.

DBLink

APIDescription
CreateDBLinkCreates a database link for a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.
DescribeDBLinksQueries the information about the database link of a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.
DeleteDBLinkDeletes a database link for a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.

Backups

CategoryAPIDescription
Backup managementCreateBackupManually creates a full snapshot for a specified PolarDB cluster.
DescribeBackupsQueries the backup information about a specified PolarDB cluster.
DescribeBackupTasksQueries the backup tasks of a specified PolarDB cluster.
DescribeBackupLogsQueries the backup logs and the URLs to download backup logs.
DescribeDetachedBackupsQueries the information about the backup set of a specified PolarDB cluster that is already released.
DescribeDBClustersWithBackupsQueries the details about the PolarDB clusters that contain backup sets and are deployed in a specified region.
DeleteBackupDeletes the backups of a specified PolarDB cluster.
Backup policyDescribeBackupPolicyQueries the automatic backup policy.
DescribeLogBackupPolicyQueries the retention policy of log backups in a specified PolarDB cluster.
ModifyBackupPolicyModifies the automatic backup policy.
ModifyLogBackupPolicyModifies the retention policy of log backups in a specified PolarDB cluster.

Tags

APIDescription
TagResourcesAdds tags to a specified PolarDB cluster.
UntagResourcesRemoves tags from a specified PolarDB cluster.
ListTagResourcesQueries the tags that are added to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are added.

Pending events

APIDescription
DescribePendingMaintenanceActionQueries the details about pending events.
DescribePendingMaintenanceActionsQueries the numbers of pending events for different types of tasks.
ModifyPendingMaintenanceActionChanges the task switch time of pending events.

Scheduled tasks

APIDescription
DescribeScheduleTasksQueries the details about all or specified scheduled tasks that belong to the current account.
CancelScheduleTasksCancels a specified scheduled task.

Monitoring

APIDescription
DescribeDBNodePerformanceQueries the performance data of a specified PolarDB cluster node.
DescribeDBClusterPerformanceQueries the performance data of a specified PolarDB cluster.
DescribeDBClusterMonitorQueries the frequency at which the monitoring data of a specified PolarDB cluster is collected.
ModifyDBClusterMonitorChanges the frequency at which the monitoring data of a specified PolarDB cluster is collected.