The following tables list API operations available for use in PolarDB for MySQL and whether they are supported on Enterprise Edition and Standard Edition.
Purchase
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateStoragePlan | Purchases a storage plan. | Supported | Not supported |
| DescribeAutoRenewAttribute | Queries the auto-renewal status of a specified subscription PolarDB cluster. | Supported | Supported |
| DescribeClassList | Queries the list of cluster specifications. | Supported | Supported |
| DescribeDBClusterAvailableResources | Queries available resources for a specified PolarDB cluster. | Supported | Supported |
| EvaluateRegionResource | Evaluates available resources. | Supported | Supported |
| ModifyAutoRenewAttribute | Configures auto-renewal for a specified subscription PolarDB cluster. | Supported | Supported |
| TransformDBClusterPayType | Changes the billing method of a specified PolarDB cluster. | Supported | Not supported |
Clusters
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateDBCluster | Creates a PolarDB cluster. | Supported | Not supported |
| DeleteDBCluster | Releases a specified pay-as-you-go PolarDB cluster. | Supported | Supported |
| DescribeDBClusters | Queries PolarDB clusters or the clusters that a RAM user is authorized to access. | Supported | Supported |
| DescribeDBClusterAttribute | Queries the detailed attributes of a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterServerlessConf | Queries the configurations of a serverless cluster. | Supported | Not supported |
| DescribeRegions | Queries the regions and the zones that are supported by PolarDB. | Supported | Supported |
| DescribeTasks | Queries further details of the tasks that are generated based on API operations. | Supported | Not supported |
| ModifyDBClusterDescription | Changes the name of a specified PolarDB cluster to facilitate cluster maintenance. | Supported | Supported |
| ModifyDBClusterDeletion | Enables or disables the cluster lock feature. | Supported | Supported |
| 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. | Supported | Supported |
| ModifyDBClusterServerlessConf | Modifies the configurations of a serverless cluster. | Supported | Not supported |
High-availability deployment architecture
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| ModifyDBClusterPrimaryZone | Changes the primary zone of a specified PolarDB cluster. | Supported | Not supported |
| FailoverDBCluster | Manually switches services from the primary node to a read-only node of a specified PolarDB cluster. You can specify a read-only node as the new primary node. | Supported | Not supported |
Database engine versions
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeDBClusterVersion | Queries the details of the database engine version of a PolarDB for MySQL cluster. | Supported | Supported |
| UpgradeDBClusterVersion | Upgrades the engine version of a PolarDB for MySQL cluster. | Supported | Supported |
Whitelists
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| ModifyDBClusterAccessWhitelist | Creates or modifies the whitelists (the IP whitelists and security groups) of a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterAccessWhitelist | Queries the IP whitelists and the security groups of a specified PolarDB cluster that can be accessed. | Supported | Supported |
Global IP whitelist templates
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. | Supported | Supported |
| DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. | Supported | Supported |
| DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. | Supported | Supported |
| DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. | Supported | Supported |
| ModifyGlobalSecurityIPGroup | Modifies an IP whitelist template. | Supported | Supported |
| ModifyGlobalSecurityIPGroupName | Modifies the name of a global IP whitelist template. | Supported | Supported |
| ModifyGlobalSecurityIPGroupRelation | Modifies the relationship between a cluster and a global IP whitelist template. | Supported | Supported |
SSL encryption
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeDBClusterSSL | Queries the SSL settings of a specified PolarDB cluster. | Supported | Supported |
| ModifyDBClusterSSL | Enables or disables Secure Sockets Layer (SSL) encryption or updates the Certificate Authorities (CA) certificate for a specified PolarDB cluster. | Supported | Supported |
TDE encryption
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CheckKMSAuthorized | Queries whether the cluster is authorized to use KMS. | Supported | Supported |
| DescribeDBClusterTDE | Queries the details about the transparent data encryption (TDE) settings of a specified PolarDB cluster. | Supported | Not supported |
| DescribeUserEncryptionKeyList | Queries the list of custom keys for a PolarDB cluster. | Supported | Supported |
| ModifyDBClusterTDE | Enables the TDE feature or changes the encryption method for a specified PolarDB for MySQL cluster. | Supported | Not supported |
Masking rules
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeMaskingRules | Queries the data masking rules that apply to a PolarDB cluster or the details of a specified masking rule. | Supported | Not supported |
| ModifyMaskingRules | Modifies or adds a data masking rule. | Supported | Not supported |
| DeleteMaskingRules | Deletes a specified data masking rule. | Supported | Not supported |
Nodes
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateDBNodes | Adds a read-only node to a specified PolarDB cluster. | Supported | Supported |
| ModifyDBNodeClass | Changes the node specifications of a PolarDB cluster. | Supported | Supported |
| ModifyDBNodesClass | Changes the specifications of a single node in a PolarDB cluster. | Supported | Supported |
| RestartDBNode | Restarts a specified node in a PolarDB cluster. | Supported | Supported |
| DeleteDBNodes | Deletes a read-only node from a specified PolarDB cluster. | Supported | Supported |
| TempModifyDBNode | Temporarily upgrades the configuration of a PolarDB cluster or adds one or more nodes to the cluster. | Supported | Supported |
Parameters
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateParameterGroup | Creates a parameter template for a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterParameters | Queries the parameters of a specified PolarDB cluster. | Supported | Supported |
| DescribeDBNodesParameters | Queries the parameters of a specified node in a PolarDB cluster. | Supported | Supported |
| DescribeParameterTemplates | Queries parameter templates of a specified PolarDB cluster. | Supported | Supported |
| DescribeParameterGroups | Queries parameter templates of a PolarDB cluster that are available in a specified region. | Supported | Supported |
| DescribeParameterGroup | Queries the details of a specified parameter template of a PolarDB cluster. | Supported | Supported |
| DeleteParameterGroup | Deletes a parameter template of a specified PolarDB cluster. | Supported | Supported |
| ModifyDBClusterAndNodesParameters | Modifies the parameters of a PolarDB cluster and applies them to specified nodes. | Supported | Supported |
| ModifyDBClusterParameters | Modifies the parameters of a specified PolarDB cluster or applies a parameter template to the cluster. | Supported | Supported |
| ModifyDBNodesParameters | Modifies the parameters of a node in a PolarDB cluster and applies them to specified nodes. | Supported | Supported |
Endpoints
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| 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. | Supported | Supported |
| CreateDBClusterEndpoint | Creates a custom cluster endpoint for a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterEndpoints | Queries the information about the endpoints of a specified PolarDB cluster. | Supported | Supported |
| 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. | Supported | Supported |
| 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. | Supported | Supported |
| 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. | Supported | Supported |
| DeleteDBClusterEndpoint | Deletes a custom cluster endpoint of a specified PolarDB cluster. | Supported | Supported |
Logs
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeSlowLogRecords | Queries the details about the slow query logs of a specified PolarDB cluster. | Supported | Supported |
| DescribeSlowLogs | Queries the statistics about the slow query logs of a specified PolarDB cluster. | Supported | Supported |
| 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. | Supported | Supported |
| ModifyDBClusterAuditLogCollector | Enables or disables SQL data collector for a specified PolarDB cluster. The features of SQL data collector include audit logs and SQL Explorer. | Supported | Supported |
Accounts
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateAccount | Creates an account for a specified PolarDB database. | Supported | Supported |
| DescribeAccounts | Queries the information about a database account for a specified PolarDB cluster. | Supported | Supported |
| 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. | Supported | Supported |
| ModifyAccountDescription | Modifies the remarks of a specified PolarDB database account. | Supported | Supported |
| ModifyAccountPassword | Changes the password of a specified PolarDB database account. | Supported | Supported |
| GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster. | Supported | Supported |
| RevokeAccountPrivilege | Revokes the database access permissions that are granted to a specified PolarDB standard account. | Supported | Supported |
| ResetAccount | Resets a specified PolarDB privileged database account. | Supported | Supported |
| DeleteAccount | Deletes a specified PolarDB database account. | Supported | Supported |
Databases
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateDatabase | Creates a database in a specified PolarDB cluster. | Supported | Supported |
| DescribeDatabases | Queries the databases in a specified PolarDB cluster. | Supported | Supported |
| ModifyDBDescription | Modifies the description or remarks of a specified PolarDB database. | Supported | Supported |
| DeleteDatabase | Deletes a database in a specified PolarDB cluster. | Supported | Supported |
| DescribeCharacterSetName | Queries character sets that PolarDB for MySQL clusters support. | Supported | Supported |
| 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. | Supported | Supported |
GDNs
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateGlobalDatabaseNetwork | Creates a global database network (GDN). | Supported | Not supported |
| DeleteGlobalDatabaseNetwork | Releases a GDN. | Supported | Not supported |
| DescribeGlobalDatabaseNetwork | Queries the details about a GDN. | Supported | Not supported |
| DescribeGlobalDatabaseNetworks | Queries the details of all GDNs for an Alibaba Cloud account. | Supported | Not supported |
| ModifyGlobalDatabaseNetwork | Modifies a GDN. | Supported | Not supported |
| RemoveDBClusterFromGDN | Removes secondary clusters from a GDN. | Supported | Not supported |
| SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a GDN. | Supported | Not supported |
Backups
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CreateBackup | Manually creates a full snapshot for a specified PolarDB cluster. | Supported | Supported |
| DescribeBackups | Queries the backup information about a specified PolarDB cluster. | Supported | Supported |
| DescribeBackupTasks | Queries the backup tasks of a specified PolarDB cluster. | Supported | Supported |
| DescribeBackupLogs | Queries the backup logs and the URLs to download backup logs. | Supported | Supported |
| DescribeDetachedBackups | Queries the information about the backup set of a specified PolarDB cluster that is already released. | Supported | Not supported |
| DescribeDBClustersWithBackups | Queries the details about the PolarDB clusters that contain backup sets and are deployed in a specified region. | Supported | Not supported |
| DeleteBackup | Deletes the backups of a specified PolarDB cluster. | Supported | Supported |
Backup policies
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeBackupPolicy | Queries the automatic backup policy. | Supported | Supported |
| DescribeLogBackupPolicy | Queries the retention policy of log backups in a specified PolarDB cluster. | Supported | Supported |
| ModifyBackupPolicy | Modifies the automatic backup policy. | Supported | Supported |
| ModifyLogBackupPolicy | Modifies the retention policy of log backups in a specified PolarDB cluster. | Supported | Supported |
Database and table restoration
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeMetaList | Queries the metadata of the database or table that you want to restore. | Supported | Not supported |
| RestoreTable | Restores a specified PolarDB database or table. | Supported | Not supported |
Data migration from RDS instances
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeDBClusterMigration | Queries the migration state of a specified PolarDB cluster. | Supported | Not supported |
| ModifyDBClusterMigration | Migrates data from an ApsaraDB RDS for MySQL instance to PolarDB, or rolls back data migration. | Supported | Not supported |
| CloseDBClusterMigration | Cancels or completes the migration for a PolarDB cluster. | Supported | Not supported |
Tags
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| TagResources | Adds tags to a specified PolarDB cluster. | Supported | Supported |
| UntagResources | Removes tags from a specified PolarDB cluster. | Supported | Supported |
| 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. | Supported | Supported |
Scheduled events
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribePendingMaintenanceAction | Queries the details about scheduled events. | Supported | Supported |
| DescribePendingMaintenanceActions | Queries the numbers of scheduled events for different types of tasks. | Supported | Supported |
| ModifyPendingMaintenanceAction | Modifies the task switching time of scheduled events. | Supported | Supported |
Scheduled tasks
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeScheduleTasks | Queries the details of all scheduled tasks or a specified scheduled task that belongs to the current account. | Supported | Supported |
| CancelScheduleTasks | Cancels a specified scheduled task. | Supported | Supported |
Monitoring
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeDBNodePerformance | Queries the performance data of a node in a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterPerformance | Queries the performance data of a specified PolarDB cluster. | Supported | Supported |
| DescribeDBClusterMonitor | Queries the frequency at which the monitoring data of a specified PolarDB cluster is collected. | Supported | Supported |
| DescribeDBProxyPerformance | Queries the performance data of PolarProxy of a PolarDB cluster. | Supported | Supported |
| ModifyDBClusterMonitor | Changes the frequency at which the monitoring data of a specified PolarDB cluster is collected. | Supported | Supported |
PolarDB for AI
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| CloseAITask | Disables the PolarDB for AI feature. | Supported | Not supported |
| DescribeAITaskStatus | Queries the status of the PolarDB for AI feature. | Supported | Not supported |
| OpenAITask | Enables the PolarDB for AI feature. | Supported | Not supported |
Connection diagnostics
| Operation | Description | Enterprise Edition | Standard Edition |
|---|---|---|---|
| DescribeDBClusterConnectivity | Queries whether the source IP address can access the cluster. | Supported | Not supported |
| ManuallyStartDBCluster | Manually starts a cluster. | Supported | Not supported |