Document Center

All Products

Document Center

PolarDB:API overview

Last Updated:Mar 23, 2023

PolarDB provides the following API operations.

Regions


API	Description
DescribeRegions	Queries the regions and the zones that are supported by PolarDB.

Clusters


Category	API	Description
Cluster management	CreateDBCluster	Creates a PolarDB cluster.
	DeleteDBCluster	Releases a specified pay-as-you-go PolarDB cluster.
	DescribeDBClusters	Queries PolarDB clusters or the clusters that a RAM user is authorized to access.
	DescribeDBClusterAttribute	Queries the detailed attributes of a specified PolarDB cluster.
	ModifyDBClusterMaintainTime	Changes 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.
	ModifyDBClusterDescription	Changes the name of a specified PolarDB cluster to facilitate cluster maintenance.
	DescribeTasks	Queries the progress details about the tasks (such as creating a cluster) that are generated by using API operations.
Architecture deployment	ModifyDBClusterPrimaryZone	Changes the primary zone of a specified PolarDB cluster.
Architecture deployment	FailoverDBCluster	Manually 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 management	DescribeAutoRenewAttribute	Queries the auto-renewal status of a specified PolarDB cluster that uses the subscription billing method.
	ModifyAutoRenewAttribute	Configures auto-renewal for a specified PolarDB cluster that uses the subscription billing method.
	DescribeDBClusterAvailableResources	Queries available resources for a specified PolarDB cluster.

Data security


Category	API	Description
Whitelist	ModifyDBClusterAccessWhitelist	Creates or modifies the whitelists (the IP whitelists and security groups) of a specified PolarDB cluster.
Whitelist	DescribeDBClusterAccessWhitelist	Queries the IP whitelists 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.
SSL encryption	DescribeDBClusterSSL	Queries the SSL settings of a specified PolarDB 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 in 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 or applies a parameter template to the 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 information about the endpoints of a specified PolarDB cluster.
ModifyDBClusterEndpoint	Modifies 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.
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
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.
CheckAccountName	Checks 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.
ModifyAccountDescription	Modifies the remarks of a specified PolarDB database account.
ModifyAccountPassword	Changes the password of a specified PolarDB database account.
DeleteAccount	Deletes a specified PolarDB database account.

Databases


API	Description
CreateDatabase	Creates a database in a specified PolarDB cluster.
DescribeDatabases	Queries the databases in a specified PolarDB cluster.
DeleteDatabase	Deletes a database in a specified PolarDB cluster.
DescribeDBInitializeVariable	Queries the attributes of a specified PolarDB for PostgreSQL(Compatible with Oracle) database, such as supported character sets and collations.
CheckDBName	Checks 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


API	Description
CreateDBLink	Creates a database link for a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.
DescribeDBLinks	Queries the information about the database link of a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.
DeleteDBLink	Deletes a database link for a specified PolarDB for PostgreSQL(Compatible with Oracle) cluster.

Backups


Category	API	Description
Backup management	CreateBackup	Manually creates a full snapshot 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 the backup logs and the URLs to download backup logs.
	DescribeDetachedBackups	Queries the information about the backup set of a specified PolarDB cluster that is already released.
	DescribeDBClustersWithBackups	Queries the details about the PolarDB clusters that contain backup sets and are deployed 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 of log backups in a specified PolarDB cluster.
	ModifyBackupPolicy	Modifies the automatic backup policy.
	ModifyLogBackupPolicy	Modifies the retention policy of log backups in a specified PolarDB cluster.

Tags


API	Description
TagResources	Adds tags to a specified PolarDB cluster.
UntagResources	Removes tags from a specified PolarDB cluster.
ListTagResources	Queries 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


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

Scheduled tasks


API	Description
DescribeScheduleTasks	Queries the details about all or specified scheduled tasks that belong to the current account.
CancelScheduleTasks	Cancels a specified scheduled task.

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.