List of API operations by function

The following tables list API operations available for use in Apsara PolarDB.

Region

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

Clusters

API	Description
ModifyDBClusterMaintainTime	Modifies the maintenance window of a specified Apsara PolarDB cluster. We recommend that you specify off-peak hours as the time period. Alibaba Cloud maintains your clusters within the specified maintenance period to minimize the negative impacts on your business.
DescribeDBClusters	Queries Apsara PolarDB clusters or clusters that are accessible to an authorized RAM user.
ModifyDBClusterDescription	Modifies the name of an Apsara PolarDB cluster to facilitate cluster maintenance.
CreateDBCluster	Creates an Apsara PolarDB cluster.
DeleteDBCluster	Releases a pay-as-you-go cluster of Apsara PolarDB.
DescribeDBClusterAttribute	Queries details about an Apsara PolarDB cluster.
ModifyAutoRenewAttribute	Sets the auto-renewal attribute for the subscription of an Apsara PolarDB cluster.
DescribeAutoRenewAttribute	Queries the auto-renewal attribute for the subscription of an Apsara PolarDB cluster.
FailoverDBCluster	Switches between the primary and secondary nodes of an Apsara PolarDB cluster. A read-only node can be specified as the new primary node.
ModifyDBClusterPrimaryZone	Changes the primary zone of an Apsara PolarDB cluster.
DescribeDBClusterAvailableResources	Queries the resources available when you purchase an Apsara PolarDB cluster.

Whitelist management

API	Description
ModifyDBClusterAccessWhitelist	Creates or modifies the IP whitelist and security groups of an Apsara PolarDB cluster.
DescribeDBClusterAccessWhitelist	Queries the IP whitelist and security groups of Apsara PolarDB clusters that you are authorized to access.

Security and encryption

API	Description
DescribeDBClusterSSL	Queries the Secure Sockets Layer (SSL) settings of an Apsara PolarDB cluster.
ModifyDBClusterSSL	Enables or disables SSL encryption, or updates the CA certificate for an Apsara PolarDB cluster.

Node management

API	Description
RestartDBNode	Restarts nodes of an Apsara PolarDB cluster.
CreateDBNodes	Adds a read-only node to an Apsara PolarDB cluster.
DeleteDBNodes	Deletes a node from an Apsara PolarDB cluster.
ModifyDBNodeClass	Modifies the node class of an Apsara PolarDB cluster.

Cluster parameters

API	Description
DescribeDBClusterParameters	Queries the parameters of an Apsara PolarDB cluster.
ModifyDBClusterParameters	Modifies the parameters of an Apsara PolarDB cluster.

Endpoints

API	Description
DescribeDBClusterEndpoints	Queries the endpoints of an Apsara PolarDB cluster.
CreateDBEndpointAddress	Creates the public endpoints of an Apsara PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.
ModifyDBEndpointAddress	Modifies the public endpoints of an Apsara PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.
DeleteDBEndpointAddress	Releases the public endpoints of an Apsara PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.
CreateDBClusterEndpoint	Creates a custom endpoint for an Apsara PolarDB cluster.
ModifyDBClusterEndpoint	Modifies the attributes of the cluster endpoint of an Apsara PolarDB cluster, including read/write mode, whether new nodes are automatically added to this endpoint, and the consistency level.
DeleteDBClusterEndpoint	Releases a custom endpoint for an Apsara PolarDB cluster.

Log management

API	Description
DescribeSlowLogs	Queries statistics about logs of slow queries for an Apsara PolarDB cluster.
DescribeSlowLogRecords	Queries detailed information about logs of slow queries in an Apsara PolarDB cluster.
DescribeDBClusterAuditLogCollector	You can call this operation to query whether SQL data collector is enabled for an Apsara PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.
ModifyDBClusterAuditLogCollector	You can call this operation to enable or disable SQL data collector for an Apsara PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer.

Account management

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

Database management

API	Description
CreateDatabase	Creates a database for an Apsara PolarDB cluster.
DescribeDatabases	Queries all databases or a specified database of an Apsara PolarDB cluster.
DeleteDatabase	Deletes a database for an Apsara PolarDB cluster.
ModifyDBDescription	Modifies the description of a database for an Apsara PolarDB cluster.

Backup management

API	Description
CreateBackup	Creates a full snapshot for an Apsara PolarDB cluster.
DeleteBackup	Deletes backups for an Apsara PolarDB cluster.
DescribeBackups	Queries the backup information for an Apsara PolarDB cluster.
ModifyBackupPolicy	Modifies the automatic backup policy of an Apsara PolarDB cluster.
DescribeBackupPolicy	Queries the automatic backup policy of an Apsara PolarDB cluster.
DescribeBackupLogs	Queries backup logs and obtain the download links.
ModifyLogBackupPolicy	Modifies the log backup retention policy of an Apsara PolarDB cluster.
DescribeDetachedBackups	Queries information about the backup that has been released in an Apsara PolarDB cluster.
DescribeLogBackupPolicy	Queries the log backup retention policy of an Apsara PolarDB cluster.
DescribeDBClustersWithBackups	Queries the details of backup sets of an Apsara PolarDB cluster in a region.

Tag management

API	Description
TagResources	Adds tags to Apsara PolarDB clusters.
UntagResources	Removes tags from Apsara PolarDB clusters.
ListTagResources	Queries the tags that are added to one or more Apsara PolarDB clusters, or the Apsara PolarDB clusters that are bound to one or more tags.

Monitoring management

API	Description
DescribeDBClusterPerformance	Queries the performance data for an ApsaraDB for PolarDB cluster.
DescribeDBNodePerformance	Queries the performance data of the nodes in an Apsara PolarDB cluster.
DescribeDBClusterPerformance	Queries the performance data of an Apsara PolarDB cluster.
ModifyDBClusterMonitor	Modifies the collection frequency of monitoring data within an Apsara PolarDB cluster.