API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (polardb/2017-08-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
PolarDB application
| API | Title | Description |
| DescribeApplications | DescribeApplications | Retrieves a list of applications for PolarDB instances in a specified region. |
| CreateApplication | CreateApplication | Creates an application for a PolarDB instance. |
| DescribeApplicationAttribute | DescribeApplicationAttribute | Retrieves the details of a specified application in a PolarDB instance. |
| DescribeApplicationParameters | DescribeApplicationParameters | Queries the parameters and template information of a specified application and its components. |
| ModifyApplicationParameter | ModifyApplicationParameter | Modifies the configuration parameters of a sub-component within a specified PolarDB application. |
| ModifyApplicationDescription | ModifyApplicationDescription | Modifies the description of a PolarDB application. |
| ModifyApplicationWhitelist | ModifyApplicationWhitelist | Modifies the IP address whitelist and security group configuration for a PolarDB application. |
| CreateApplicationEndpointAddress | CreateApplicationEndpointAddress | Creates a connection address for a specified application. |
| DeleteApplicationEndpointAddress | DeleteApplicationEndpointAddress | Deletes a specific connection address for a PolarDB application. |
| AttachApplicationPolarFS | AttachApplicationPolarFS | Attaches a specified PolarFileSystem (PolarFS) instance to a PolarDB application. |
| DeleteApplication | DeleteApplication | Deletes the specified PolarDB application. This operation does not delete the associated PolarDB instance. |
Edge Cluster
| API | Title | Description |
| UpgradeDBClusterVersionZonal | UpgradeDBClusterVersionZonal | Upgrade the minor version of a PolarDB edge cloud cluster |
| CreateAccountZonal | CreateAccountZonal | Creates an account for an edge zone. |
| RestartDBNodeZonal | RestartDBNodeZonal | Restarts a node of a PolarDB edge cloud cluster. |
| DescribeAccountsZonal | DescribeAccountsZonal | Retrieve a list of PolarDB Edge Cloud clusters |
| DeleteDBClusterEndpointZonal | DeleteDBClusterEndpointZonal | Deletes a cluster endpoint from a PolarDB Edge Cloud cluster. |
| CreateDatabaseZonal | CreateDatabaseZonal | Create a PolarDB edge database |
| GrantAccountPrivilegeZonal | GrantAccountPrivilegeZonal | Modify account permissions in a PolarDB edge cluster |
| ModifyDBDescriptionZonal | ModifyDBDescriptionZonal | Modifies the description of a database in a PolarDB for Cloud Edge cluster. |
| CheckDBNameZonal | CheckDBNameZonal | Checks the name of a database in PolarDB for Edge Cloud. |
| DescribeDBClusterVersionZonal | DescribeDBClusterVersionZonal | Queries the version of a PolarDB edge cluster. |
| ModifyDBClusterEndpointZonal | ModifyDBClusterEndpointZonal | Modifies the endpoint of a PolarDB cluster in an edge zone. |
| ModifyAccountPasswordZonal | ModifyAccountPasswordZonal | Modifies the password for a PolarDB for All-in-One account. |
| DeleteAccountZonal | DeleteAccountZonal | Deletes an account from a PolarDB edge cluster. |
| ModifyAccountDescriptionZonal | ModifyAccountDescriptionZonal | Modifies the description of a PolarDB for Edge account. |
| ResetAccountZonal | ResetAccountZonal | Resets an account for a PolarDB for Xscale cluster. |
| CreateDBClusterEndpointZonal | CreateDBClusterEndpointZonal | Creates a connection endpoint in an edge zone. |
| RevokeAccountPrivilegeZonal | RevokeAccountPrivilegeZonal | Revokes permissions from an account. |
| ModifyDBClusterDescriptionZonal | ModifyDBClusterDescriptionZonal | Modifies the description of a cluster. |
| DescribeDatabasesZonal | DescribeDatabasesZonal | Describes the databases in a PolarDB for Edge Cloud cluster. |
| DescribeDBClusterEndpointsZonal | DescribeDBClusterEndpointsZonal | Queries the endpoints of a PolarDB edge cluster. |
| DeleteDatabaseZonal | DeleteDatabaseZonal | Deletes a database from a PolarDB edge cloud cluster. |
| FailoverDBClusterZonal | FailoverDBClusterZonal | Role switching |
| DescribeDbClusterAttributeZonal | DescribeDbClusterAttributeZonal | PolarDB MyBase: Dedicated cluster |
| CheckAccountNameZonal | CheckAccountNameZonal | Checks whether a PolarDB account name is valid. |
| DescribeDBClustersZonal | DescribeDBClustersZonal | Lists the PolarDB clusters in MyBase. |
Other
| API | Title | Description |
| DescribeActivationCodes | DescribeActivationCodes | Retrieves a paginated list of activation codes associated with your account. You can filter the results by order ID or specific hardware identifiers. |
| DescribeLicenseOrderDetails | DescribeLicenseOrderDetails | Queries the information of a license order. |
| DescribeLicenseOrders | DescribeLicenseOrders | Queries a list of license orders. |
| AbortDBClusterMigration | AbortDBClusterMigration | Aborts an upgrade or migration task. |
| CreateOrGetVirtualLicenseOrder | CreateOrGetVirtualLicenseOrder | Creates or obtains a virtual license order. |
| CreateActivationCode | CreateActivationCode | Generates a lightweight license activation code. |
| DescribeActivationCodeDetails | DescribeActivationCodeDetails | Queries the details of an activation code. |
| AddEncryptionDBRolePrivilege | AddEncryptionDBRolePrivilege | Grants permissions to a role. |
| CreateGlobalDataNetwork | CreateGlobalDataNetwork | Creates a new PolarFS Global Data Network (GDN). |
| AddFirewallRules | AddFirewallRules | Adds SQL firewall rules. |
| DescribeGlobalDataNetworkList | DescribeGlobalDataNetworkList | Queries the details of PolarFileSystem (PolarFS) Global Data Networks (GDNs) across gemini 建议 across，更地道 inall regions in your account. |
| DeleteGlobalDataNetwork | DeleteGlobalDataNetwork | Deletes a specific PolarFileSystem (PolarFS) Global Database Network (GDN). |
| DescribeHistoryTasks | DescribeHistoryTasks | Retrieves a list of historical administrative tasks for PolarDB for MySQL instances, such as parameter changes, and instance restarts. |
| AddSQLRateLimitingRules | AddSQLRateLimitingRules | Adds SQL throttling rules. |
| DescribeHALogs | DescribeHALogs | Queries high availability (HA) logs for an instance. |
| DescribeAIDBClusterPerformance | DescribeAIDBClusterPerformance | Retrieves the performance metrics of an AI container. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | You can call the CreateServiceLinkedRole operation to create a service-linked role. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role has been created. |
| ModifyDBNodeDescription | ModifyDBNodeDescription | Modifies the name of a node in a PolarDB cluster. |
| DescribeBackupRegions | DescribeBackupRegions | Queries the regions that store backup sets. |
| CancelCronJobPolicyServerless | CancelCronJobPolicyServerless | This operation cancels an auto triggered task policy. |
| CheckConnectionString | CheckConnectionString | Checks a connection string. |
| ContinueDBClusterMigration | ContinueDBClusterMigration | Continues the current migration or upgrade task. |
| CreateCronJobPolicyServerless | CreateCronJobPolicyServerless | Creates a scheduled task policy for a serverless cluster. |
| CreateExtensions | CreateExtensions | This operation creates extensions. |
| CreateNetworkChannel | CreateNetworkChannel | Creates a network channel. |
| DeleteAIDBCluster | DeleteAIDBCluster | Deletes an AI cluster instance. |
| DeleteEncryptionDBRolePrivilege | DeleteEncryptionDBRolePrivilege | Deletes a role. |
| DeleteExtensions | DeleteExtensions | Delete a plugin |
| DeleteFirewallRules | DeleteFirewallRules | Deletes the specified SQL firewall rules. |
| DeleteNetworkChannel | DeleteNetworkChannel | Deletes a network channel. |
| DeleteSQLRateLimitingRules | DeleteSQLRateLimitingRules | Deletes SQL throttling rules. |
| DescribeAIDBClusterAttribute | DescribeAIDBClusterAttribute | Viewing custom instance details |
| DescribeAIDBClusters | DescribeAIDBClusters | Retrieves a list of custom clusters. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the Operations and Maintenance (O&M) configuration for a user, including the active O&M window. |
| DescribeAvailableCrossRegions | DescribeAvailableCrossRegions | Retrieves a list of regions available for cross-region backup. |
| DescribeColdStorageInstance | DescribeColdStorageInstance | Queries information about cold storage instances. |
| DescribeCronJobPolicyServerless | DescribeCronJobPolicyServerless | Queries the policies for automatically triggered tasks. |
| DescribeCrossCloudLevels | DescribeCrossCloudLevels | Queries the supported cross-cloud specifications. |
| DescribeCrossCloudRegion | DescribeCrossCloudRegion | Queries information about cross-cloud regions. |
| DescribeCrossCloudRegionMappingToAliyun | DescribeCrossCloudRegionMappingToAliyun | This operation queries cross-cloud region mappings. |
| DescribeDBClusterEncryptionKey | DescribeDBClusterEncryptionKey | Queries the key usage details for a specified PolarDB cluster. |
| DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | Queries information about database endpoints. |
| DescribeDBClusterProxy | DescribeDBClusterProxy | Queries the details of a database cluster proxy. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance monitoring data for a compute node. |
| DescribeDBLogFiles | DescribeDBLogFiles | Queries the logs of a PolarDB cluster, such as primary/secondary failover logs. |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries the available minor engine versions. |
| DescribeEncryptionDBRolePrivilege | DescribeEncryptionDBRolePrivilege | Queries a list of permissions for a database role. |
| DescribeEncryptionDBSecret | DescribeEncryptionDBSecret | Queries encryption key information. |
| DescribeExtensions | DescribeExtensions | Viewing plugin details |
| DescribeFirewallRules | DescribeFirewallRules | Describes SQL firewall rules. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries task statistics in Task Hub. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | Queries the available time range to recover from a backup. |
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the modification history of parameters. |
| DescribeNetworkChannel | DescribeNetworkChannel | Queries network channels. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | This operation describes a list of VPCs. |
| DescribeResourcePackages | DescribeResourcePackages | Queries a list of cross-cloud resource packages. |
| DescribeSQLRateLimitingRules | DescribeSQLRateLimitingRules | Returns the details of SQL throttling rules. |
| DescribeUpgradeReport | DescribeUpgradeReport | Queries the verification reports. |
| DescribeVSwitchList | DescribeVSwitchList | Retrieves information about vSwitches. |
| DescribeVpcs | DescribeVpcs | Queries the details of one or more VPCs. |
| DescribeZones | DescribeZones | Queries the available zones. |
| DisableDBClusterOrca | DisableDBClusterOrca | Shuts down the relational component of the cluster. |
| EnableDBClusterOrca | EnableDBClusterOrca | Enabling cluster relationships |
| EnableSQLRateLimitingRules | EnableSQLRateLimitingRules | Enables or disables SQL throttling rules. |
| ExecuteCrossCloudOpenAPI | ExecuteCrossCloudOpenAPI | Invokes a cross-cloud OpenAPI. |
| GenerateUpgradeReportForSyncClone | GenerateUpgradeReportForSyncClone | Generates a report for a pre-upgrade check. |
| ListOrders | ListOrders | Queries a list of orders. |
| ListTagResourcesForRegion | ListTagResourcesForRegion | Queries the tags that are attached to resources in a specified region. |
| ModifyAIDBClusterDescription | ModifyAIDBClusterDescription | Modify the name of an AI instance |
| ModifyAccountLockState | ModifyAccountLockState | Changes the lock status of a PolarDB database account. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Configures the operations and maintenance (O&M) settings for a user. These settings include the active maintenance window. |
| ModifyCronJobPolicyServerless | ModifyCronJobPolicyServerless | Modifies the policy for a scheduled task. |
| ModifyDBClusterMigrationEndpoint | ModifyDBClusterMigrationEndpoint | Modifies the source and target instances of a Data Transmission Service (DTS) task. |
| ModifyDBClusterVpc | ModifyDBClusterVpc | Modifies the VSwitch parameters for a cluster. |
| ModifyDBNodeConfig | ModifyDBNodeConfig | Modifies the configuration of a node in a PolarDB cluster. |
| ModifyDBNodeSccMode | ModifyDBNodeSccMode | Modifies the SCC mode of a node. |
| ModifyEncryptionDBRolePrivilege | ModifyEncryptionDBRolePrivilege | Modifies role permissions. |
| ModifyEncryptionDBSecret | ModifyEncryptionDBSecret | Modifies an encryption policy. |
| ModifyFirewallRules | ModifyFirewallRules | Modifies the configuration of the SQL firewall. |
| ModifyResourcePackage | ModifyResourcePackage | Modifies a cross-cloud resource plan. |
| ModifySQLRateLimitingRules | ModifySQLRateLimitingRules | Modifies SQL throttling rules. |
| ModifyScheduleTask | ModifyScheduleTask | Modifies the specified scheduled task. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for a PolarDB database account. |
| UpdateExtensions | UpdateExtensions | Updates one or more extensions. |
Others
| API | Title | Description |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
| CancelScheduleTasks | CancelScheduleTasks | Cancels scheduled tasks that are not yet started. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| CheckDBName | CheckDBName | Checks whether a database name is valid or whether the name is already used by another database in the current cluster. |
| CheckKMSAuthorized | CheckKMSAuthorized | Queries whether the cluster is authorized to use Key Management Service (KMS). |
| CloseDBClusterMigration | CloseDBClusterMigration | Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster. |
| CreateAccount | CreateAccount | Creates a PolarDB database account. |
| CreateBackup | CreateBackup | Creates a full snapshot backup for a PolarDB cluster. |
| CreateColdStorageInstance | CreateColdStorageInstance | Creates a cluster that is used to store cold data. |
| CreateDBCluster | CreateDBCluster | This operation creates a DB cluster. |
| CreateDBClusterEndpoint | CreateDBClusterEndpoint | Creates a custom cluster endpoint for a PolarDB cluster. |
| CreateDBEndpointAddress | CreateDBEndpointAddress | Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint. |
| CreateDBLink | CreateDBLink | Creates a database link. |
| CreateDBNodes | CreateDBNodes | Adds read-only nodes to a PolarDB cluster. |
| CreateDatabase | CreateDatabase | Creates a database for a PolarDB cluster. |
| CreateGlobalDatabaseNetwork | CreateGlobalDatabaseNetwork | Creates a global database network (GDN). |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| CreateParameterGroup | CreateParameterGroup | Creates a PolarDB parameter template. |
| CreateStoragePlan | CreateStoragePlan | Purchases a storage plan. |
| DeleteAccount | DeleteAccount | Deletes a database account for a PolarDB cluster. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| DeleteDBCluster | DeleteDBCluster | Releases a pay-as-you-go PolarDB cluster. |
| DeleteDBClusterEndpoint | DeleteDBClusterEndpoint | Deletes a custom cluster endpoint for a PolarDB cluster. |
| DeleteDBEndpointAddress | DeleteDBEndpointAddress | Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint. |
| DeleteDBLink | DeleteDBLink | Deletes a database link from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
| DeleteDBNodes | DeleteDBNodes | Deletes read-only nodes from a PolarDB cluster. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a PolarDB cluster. |
| DeleteGlobalDatabaseNetwork | DeleteGlobalDatabaseNetwork | Deletes a global database network (GDN). |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DeleteMaskingRules | DeleteMaskingRules | Deletes a data masking rule. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a parameter template from a PolarDB cluster. |
| DescribeAccounts | DescribeAccounts | Queries information about a database account of a PolarDB cluster. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the details of operation and maintenance events for instances. |
| DescribeApplicationServerlessConf | DescribeApplicationServerlessConf | Queries the serverless configuration for a PolarDB application. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Describes the auto-renewal status of a subscription PolarDB cluster. |
| DescribeBackupLogs | DescribeBackupLogs | Queries backup logs and the URLs to download the backup logs. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the automatic backup policy of a PolarDB cluster. |
| DescribeBackupTasks | DescribeBackupTasks | Queries the details of backup tasks of a cluster. |
| DescribeBackups | DescribeBackups | Queries backup information for a PolarDB cluster. |
| DescribeCharacterSetName | DescribeCharacterSetName | Queries character sets that are supported by a PolarDB for MySQL cluster. |
| DescribeClassList | DescribeClassList | Lists the available cluster specifications. |
| DescribeDBClusterAccessWhitelist | DescribeDBClusterAccessWhitelist | Queries the IP address whitelists and security groups of a PolarDB cluster. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries the attributes of a cluster. |
| DescribeDBClusterAuditLogCollector | DescribeDBClusterAuditLogCollector | Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer. |
| DescribeDBClusterAvailableResources | DescribeDBClusterAvailableResources | Queries available resources in a PolarDB cluster. |
| DescribeDBClusterConnectivity | DescribeDBClusterConnectivity | Queries whether the source IP address can access a cluster. |
| DescribeDBClusterEndpoints | DescribeDBClusterEndpoints | Queries information about the endpoints of a PolarDB cluster. |
| DescribeDBClusterMigration | DescribeDBClusterMigration | The ID of the synchronous task. |
| DescribeDBClusterMonitor | DescribeDBClusterMonitor | Queries the interval at which the monitoring data of a PolarDB cluster is collected. |
| DescribeDBClusterParameters | DescribeDBClusterParameters | Queries the parameters of a PolarDB cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of a PolarDB cluster. |
| DescribeDBClusterSSL | DescribeDBClusterSSL | Queries the SSL settings of a PolarDB cluster. |
| DescribeDBClusterServerlessConf | DescribeDBClusterServerlessConf | Queries the serverless configurations of a serverless cluster. |
| DescribeDBClusterTDE | DescribeDBClusterTDE | Queries the details of the transparent data encryption (TDE) settings for a specified PolarDB cluster. |
| DescribeDBClusterVersion | DescribeDBClusterVersion | Retrieves the details of the current kernel version for a PolarDB for MySQL cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries the details of specified PolarDB clusters or clusters with RAM authorization. |
| DescribeDBClustersWithBackups | DescribeDBClustersWithBackups | Queries the information about PolarDB clusters that contain backup sets in a region. |
| DescribeDBInitializeVariable | DescribeDBInitializeVariable | Queries attributes such as character sets and collations supported by a database in a PolarDB cluster. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for Oracle cluster. |
| DescribeDBNodePerformance | DescribeDBNodePerformance | Queries the performance data of a node in a PolarDB cluster. |
| DescribeDBNodesParameters | DescribeDBNodesParameters | Queries the parameters of a specified node in a cluster. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of PolarProxy. |
| DescribeDasConfig | DescribeDasConfig | Queries the configurations of a cluster in Database Autonomy Service (DAS). |
| DescribeDatabases | DescribeDatabases | Queries the information about databases in a PolarDB cluster. |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the information about the backup sets in a released PolarDB cluster. |
| DescribeGlobalDatabaseNetwork | DescribeGlobalDatabaseNetwork | Queries the information about a Global Database Network (GDN). |
| DescribeGlobalDatabaseNetworks | DescribeGlobalDatabaseNetworks | Queries the information about all Global Database Networks (GDNs) that belong to an account. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| DescribeLogBackupPolicy | DescribeLogBackupPolicy | Queries the log backup retention policy for a PolarDB cluster. |
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| DescribeMetaList | DescribeMetaList | Queries the details of the databases or tables that can be restored. |
| DescribeParameterGroup | DescribeParameterGroup | Queries the details of a parameter template. |
| DescribeParameterGroups | DescribeParameterGroups | Queries parameter templates that are available in a specified region. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the default parameters of a database cluster. |
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Queries the numbers of scheduled events for different types of tasks. |
| DescribePolarSQLCollectorPolicy | DescribePolarSQLCollectorPolicy | Queries whether the SQL Explorer feature is enabled for the cluster. |
| DescribeRegions | DescribeRegions | Queries the regions and zones that are supported by PolarDB. |
| DescribeScheduleTasks | DescribeScheduleTasks | Queries the details of all scheduled tasks. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of slow query logs for a PolarDB cluster. |
| DescribeSlowLogs | DescribeSlowLogs | Queries statistics of slow query logs for a PolarDB cluster. |
| DescribeTasks | DescribeTasks | Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster. |
| DescribeVSwitches | DescribeVSwitches | Queries a vSwitch. |
| DisableDBClusterServerless | DisableDBClusterServerless | Disables a stable serverless cluster. |
| EnableDBClusterServerless | EnableDBClusterServerless | Enables a stable serverless cluster. |
| EnableFirewallRules | EnableFirewallRules | Modifies the status of SQL firewall rules for a cluster. |
| EvaluateRegionResource | EvaluateRegionResource | Evaluates available resources. |
| FailoverDBCluster | FailoverDBCluster | Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster. |
| ManuallyStartDBCluster | ManuallyStartDBCluster | Manually starts a cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account of a PolarDB cluster. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a database account for a specified PolarDB cluster. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\&M events for an instance. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Sets the auto-renewal status for a subscription PolarDB cluster. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy of a PolarDB cluster. |
| ModifyDBCluster | ModifyDBCluster | Modifies the configurations of a PolarDB for MySQL cluster. |
| ModifyDBClusterAccessWhitelist | ModifyDBClusterAccessWhitelist | Creates or modifies the whitelists (IP whitelists and security groups) of a specified cluster. |
| ModifyDBClusterAndNodesParameters | ModifyDBClusterAndNodesParameters | Modifies cluster parameters and applies them to specified nodes. |
| ModifyDBClusterArch | ModifyDBClusterArch | Changes the high availability mode of the cluster. |
| ModifyDBClusterAuditLogCollector | ModifyDBClusterAuditLogCollector | Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer. |
| ModifyDBClusterDeletion | ModifyDBClusterDeletion | Enables or disables the cluster lock feature for a PolarDB cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the name of a PolarDB cluster. |
| ModifyDBClusterEndpoint | ModifyDBClusterEndpoint | Modifies the attributes of a specified PolarDB cluster endpoint. For example, you can modify the following attributes for the specified cluster endpoint: read/write mode, consistency level, transaction splitting, primary node accepts read requests, and connection pool. You can also call the operation to specify whether newly added nodes are automatically associated with the specified cluster endpoint. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the maintenance window of a PolarDB cluster. |
| ModifyDBClusterMigration | ModifyDBClusterMigration | Switches or rolls back the task that migrates data from ApsaraDB for RDS to PolarDB. |
| ModifyDBClusterMonitor | ModifyDBClusterMonitor | Modifies the interval at which the monitoring data of a PolarDB cluster is collected. |
| ModifyDBClusterParameters | ModifyDBClusterParameters | Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster. |
| ModifyDBClusterPrimaryZone | ModifyDBClusterPrimaryZone | Changes the primary zone of a PolarDB cluster. |
| ModifyDBClusterResourceGroup | ModifyDBClusterResourceGroup | Modifies the resource group of a database cluster. |
| ModifyDBClusterSSL | ModifyDBClusterSSL | Enables or disables SSL encryption for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster. |
| ModifyDBClusterServerlessConf | ModifyDBClusterServerlessConf | Modifies the configurations of a serverless cluster. |
| ModifyDBClusterStoragePerformance | ModifyDBClusterStoragePerformance | Modifies the storage performance of a PolarDB MySQL cluster. |
| ModifyDBClusterStorageSpace | ModifyDBClusterStorageSpace | Modifies the storage space of pay-as-you-go Enterprise Edition and Standard Edition clusters. |
| ModifyDBClusterTDE | ModifyDBClusterTDE | Enables the transparent data encryption (TDE) feature for a PolarDB cluster. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of a database in a PolarDB for MySQL cluster. |
| ModifyDBEndpointAddress | ModifyDBEndpointAddress | Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name. |
| ModifyDBNodeClass | ModifyDBNodeClass | Changes the node specifications of a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| ModifyDBNodesClass | ModifyDBNodesClass | Modifies the specifications of a single node in a PolarDB cluster. |
| ModifyDBNodesParameters | ModifyDBNodesParameters | Modifies the parameters of a node and applies them to specified nodes. |
| ModifyGlobalDatabaseNetwork | ModifyGlobalDatabaseNetwork | Modifies a global database network (GDN). |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Modifies an IP whitelist template. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | Modifies the name of a global IP whitelist template. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Modifies the relationship between a cluster and a global IP whitelist template. |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup retention policy for a PolarDB cluster. |
| ModifyMaskingRules | ModifyMaskingRules | Modifies the configuration of existing data masking 缺少关键词 data，全文修改 masking rule 为 data masking rulerules or adds new one冗余 masking rules. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
| ReactivateDBClusterBackup | ReactivateDBClusterBackup | Reactivates the backup feature. |
| RefreshDBClusterStorageUsage | RefreshDBClusterStorageUsage | Refreshes the storage usage for a cluster instance. |
| RemoveDBClusterFromGDN | RemoveDBClusterFromGDN | Removes a secondary cluster from a GDN. |
| ResetAccount | ResetAccount | Resets the permissions of a privileged account for a PolarDB cluster. |
| ResetGlobalDatabaseNetwork | ResetGlobalDatabaseNetwork | Rebuilds a secondary cluster in a Global Database Network (GDN). |
| RestartDBLink | RestartDBLink | Restarts database links. |
| RestartDBNode | RestartDBNode | Restarts a node of a PolarDB cluster. |
| RestoreTable | RestoreTable | Restores PolarDB databases and tables. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes the access permissions on one or more databases from a specified PolarDB standard account. |
| SwitchOverGlobalDatabaseNetwork | SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a global database network (GDN). |
| TagResources | TagResources | Creates tags for a PolarDB cluster. |
| TempModifyDBNode | TempModifyDBNode | Temporarily changes the node configurations. |
| TransformDBClusterPayType | TransformDBClusterPayType | Changes the billing method of a PolarDB cluster. |
| UntagResources | UntagResources | Unbinds tags from PolarDB clusters. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |