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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Sales management
|
API |
Title |
Description |
| CreateStoragePlan | CreateStoragePlan | Purchases a storage plan. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Describes the auto-renewal status of a subscription PolarDB cluster. |
| DescribeClassList | DescribeClassList | Lists the available cluster specifications. |
| EvaluateRegionResource | EvaluateRegionResource | Evaluates the resources in a region. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Sets the auto-renewal status for a subscription PolarDB cluster. |
| TransformDBClusterPayType | TransformDBClusterPayType | Changes the billing method of a PolarDB cluster. |
Cluster management
|
API |
Title |
Description |
| CreateDBCluster | CreateDBCluster | Creates a DB cluster. |
| DeleteDBCluster | DeleteDBCluster | Releases a pay-as-you-go PolarDB cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries the details of PolarDB clusters, including clusters that you are authorized to access through Resource Access Management (RAM). |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries the attributes of a specified cluster. |
| DescribeDBClusterServerlessConf | DescribeDBClusterServerlessConf | Queries the configuration of a serverless cluster. |
| DescribePolarSQLCollectorPolicy | DescribePolarSQLCollectorPolicy | Checks whether the SQL Explorer feature is enabled for a target cluster. |
| DescribeTasks | DescribeTasks | Queries the progress details of tasks generated by API calls, such as creating a cluster. |
| DescribeVSwitches | DescribeVSwitches | Queries the details of one or more vSwitches. |
| ModifyDBCluster | ModifyDBCluster | Modifies the feature configurations of a PolarDB for MySQL cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the description of a PolarDB cluster. |
| ModifyDBClusterDeletion | ModifyDBClusterDeletion | Enables or disables the cluster lock. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the routine maintenance window for a PolarDB cluster. |
| EnableDBClusterServerless | EnableDBClusterServerless | Enables the Serverless feature for a cluster. |
| DisableDBClusterServerless | DisableDBClusterServerless | Disables the Serverless feature for a cluster. |
| ModifyDBClusterStorageSpace | ModifyDBClusterStorageSpace | Modifies the storage space of a Standard Edition or Enterprise Edition cluster that uses the pay-by-storage billing method. |
| ManuallyStartDBCluster | ManuallyStartDBCluster | Starts a DB cluster. |
| ModifyDBClusterStoragePerformance | ModifyDBClusterStoragePerformance | Modifies the storage performance of a PolarDB for MySQL cluster. |
| RefreshDBClusterStorageUsage | RefreshDBClusterStorageUsage | Refreshes the storage usage for a cluster instance. |
| ModifyDBClusterResourceGroup | ModifyDBClusterResourceGroup | Modifies the resource group of a database cluster. |
High-availability deployment architecture
|
API |
Title |
Description |
| ModifyDBClusterPrimaryZone | ModifyDBClusterPrimaryZone | Changes the primary zone of a PolarDB cluster. |
| ModifyDBClusterArch | ModifyDBClusterArch | Modifies the high-availability mode of a cluster. |
Engine versions management
|
API |
Title |
Description |
| DescribeDBClusterVersion | DescribeDBClusterVersion | Retrieves the details of the current kernel version for a PolarDB for MySQL cluster. |
Whitelist management
|
API |
Title |
Description |
| ModifyDBClusterAccessWhitelist | ModifyDBClusterAccessWhitelist | Creates or modifies the access whitelist for a cluster. The whitelist can be an IP address whitelist or a security group. |
Global IP whitelist template management
|
API |
Title |
Description |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Modifies an IP address whitelist template. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | Modifies the name of a global IP address whitelist template. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Modifies the association between a cluster and a global IP address whitelist template. |
TDE
|
API |
Title |
Description |
| CheckKMSAuthorized | CheckKMSAuthorized | Checks whether a user is authorized to use Key Management Service (KMS). |
| DescribeDBClusterTDE | DescribeDBClusterTDE | Queries the details of the transparent data encryption (TDE) settings for a specified PolarDB cluster. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Retrieves a list of Key Management Service (KMS) keys. |
| ModifyDBClusterTDE | ModifyDBClusterTDE | ModifyDBClusterTDE |
SQL firewall
|
API |
Title |
Description |
| EnableFirewallRules | EnableFirewallRules | Modifies the status of SQL firewall rules for a cluster. |
Node management
|
API |
Title |
Description |
| CreateDBNodes | CreateDBNodes | Adds one or more read-only nodes to a PolarDB cluster. |
| DeleteDBNodes | DeleteDBNodes | Deletes read-only nodes from a PolarDB cluster. |
| ModifyDBNodeClass | ModifyDBNodeClass | Changes the node specifications of a PolarDB cluster. |
| ModifyDBNodesClass | ModifyDBNodesClass | Modifies the class of one or more nodes in a PolarDB cluster. |
| RestartDBNode | RestartDBNode | Restarts a node of a PolarDB cluster. |
| TempModifyDBNode | TempModifyDBNode | Temporarily modifies the configurations of a node. |
Cluster parameters management
|
API |
Title |
Description |
| CreateParameterGroup | CreateParameterGroup | Creates a PolarDB parameter template. |
| DescribeDBClusterParameters | DescribeDBClusterParameters | Queries the list of running parameters for a PolarDB cluster. |
| DescribeDBNodesParameters | DescribeDBNodesParameters | Queries the parameters for specified nodes in a cluster. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the default parameters of a database cluster. |
| DescribeParameterGroups | DescribeParameterGroups | This operation queries the parameter templates in a specified region. |
| DescribeParameterGroup | DescribeParameterGroup | Queries the details of a parameter template. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a PolarDB parameter template. |
| ModifyDBClusterAndNodesParameters | ModifyDBClusterAndNodesParameters | Modifies the parameters of a cluster and applies the new values to specified nodes. |
| ModifyDBClusterParameters | ModifyDBClusterParameters | Modifies the parameters of a PolarDB cluster or applies an existing parameter template to a destination cluster. |
| ModifyDBNodesParameters | ModifyDBNodesParameters | Modifies and applies the parameters of one or more nodes. |
Connection points management
|
API |
Title |
Description |
| 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 of a PolarDB cluster. |
| DescribeDBClusterEndpoints | DescribeDBClusterEndpoints | Queries endpoint information for a PolarDB cluster. |
| ModifyDBClusterEndpoint | ModifyDBClusterEndpoint | This operation modifies the properties of a PolarDB cluster endpoint. You can configure settings such as the read/write mode, automatic node addition, consistency level, transaction splitting, the connection pool, and whether the primary node accepts read requests. |
| ModifyDBEndpointAddress | ModifyDBEndpointAddress | Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name. |
| DeleteDBClusterEndpoint | DeleteDBClusterEndpoint | Deletes a custom cluster endpoint for a PolarDB cluster. |
Logs management
|
API |
Title |
Description |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of slow query logs for a PolarDB cluster. |
| DescribeSlowLogs | DescribeSlowLogs | Queries the slow query log statistics for a PolarDB cluster. |
Account management
|
API |
Title |
Description |
| CreateAccount | CreateAccount | Creates a PolarDB database account. |
| DescribeAccounts | DescribeAccounts | Queries information about a database account of a PolarDB cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a PolarDB database account. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes access permissions on a database from a PolarDB standard account. |
| DeleteAccount | DeleteAccount | Deletes a PolarDB database account. |
Database management
|
API |
Title |
Description |
| DescribeDatabases | DescribeDatabases | Queries for the details of databases in a specified PolarDB cluster. |
| DescribeCharacterSetName | DescribeCharacterSetName | Queries the character sets supported by PolarDB for MySQL. |
| CheckDBName | CheckDBName | Checks whether a database name is valid or if a database with the same name already exists in the current cluster. |
| DescribeDBInitializeVariable | DescribeDBInitializeVariable | Queries the supported character sets, collations, and other properties of a PolarDB database. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of a database in a PolarDB for MySQL cluster. |
Backup management
|
API |
Title |
Description |
| CreateBackup | CreateBackup | Creates a full snapshot backup for a PolarDB cluster. |
| DescribeBackups | DescribeBackups | Queries backup information for a PolarDB cluster. |
| DescribeBackupTasks | DescribeBackupTasks | Retrieves a list of backup jobs and their details for a cluster. |
| DescribeBackupLogs | DescribeBackupLogs | Queries a list of backup logs and returns their download URLs. |
| DescribeDBClustersWithBackups | DescribeDBClustersWithBackups | Queries the details of PolarDB clusters in a region that have backup sets. |
Restore management
|
API |
Title |
Description |
| DescribeMetaList | DescribeMetaList | Queries the details of recoverable databases and tables. |
| RestoreTable | RestoreTable | Restores databases or tables to a PolarDB cluster. |
Data migration from RDS
|
API |
Title |
Description |
| DescribeDBClusterMigration | DescribeDBClusterMigration | Queries the migration status of a PolarDB cluster. |
| ModifyDBClusterMigration | ModifyDBClusterMigration | Switches or rolls back a migration task for a one-click upgrade from RDS to PolarDB. |
Tag management
|
API |
Title |
Description |
| TagResources | TagResources | Adds tags to PolarDB clusters. |
| UntagResources | UntagResources | Detaches tags from a PolarDB cluster. |
| ListTagResources | ListTagResources | Queries the tags that are attached to one or more PolarDB clusters, or the PolarDB clusters that are attached to one or more tags. |
Pending events management
|
API |
Title |
Description |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Retrieves a count of pending events for various task types. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the details of operation and maintenance events for instances. |
Scheduled tasks management
|
API |
Title |
Description |
| DescribeScheduleTasks | DescribeScheduleTasks | Queries the details of all scheduled tasks. |
| CancelScheduleTasks | CancelScheduleTasks | Cancels scheduled tasks that have not started. |
Masking rules management
|
API |
Title |
Description |
| ModifyMaskingRules | ModifyMaskingRules | Modifies the configuration of existing data masking 缺少关键词 data，全文修改 masking rule 为 data masking rulerules or adds new one冗余 masking rules. |
| DeleteMaskingRules | DeleteMaskingRules | Deletes the specified data masking rules. |
Monitoring management
|
API |
Title |
Description |
| DescribeDBNodePerformance | DescribeDBNodePerformance | Queries performance data for a node in a PolarDB cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of a PolarDB cluster. |
DBLink
|
API |
Title |
Description |
| CreateDBLink | CreateDBLink | Creates a DBLink. |
| DeleteDBLink | DeleteDBLink | Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
Cold data archiving
|
API |
Title |
Description |
| CreateColdStorageInstance | CreateColdStorageInstance | Creates a cold storage instance. |
PolarDB applications
|
API |
Title |
Description |
| DescribeApplications | DescribeApplications | This operation queries the applications of all PolarDB instances in a specified region. |
| CreateApplication | CreateApplication | Creates an application for a PolarDB instance. |
| DescribeApplicationAttribute | DescribeApplicationAttribute | Retrieves the details of a specified application for a PolarDB instance. |
| DescribeApplicationParameters | DescribeApplicationParameters | Retrieves the current parameters and template information for a specified application and its components. |
| ModifyApplicationParameter | ModifyApplicationParameter | Modifies the configuration parameters of a sub-component within a specified PolarDB application. |
| ModifyApplicationDescription | ModifyApplicationDescription | Updates 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 specified 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 | Upgrades the minor version of a PolarDB cluster. |
| CreateAccountZonal | CreateAccountZonal | Creates an account for a PolarDB on ENS cluster. |
| RestartDBNodeZonal | RestartDBNodeZonal | Restarts a node of an edge cluster for PolarDB on ENS. |
| DescribeAccountsZonal | DescribeAccountsZonal | Queries the edge clusters for PolarDB on ENS. |
| DeleteDBClusterEndpointZonal | DeleteDBClusterEndpointZonal | Deletes a cluster endpoint of a PolarDB for Edge cluster. |
| CreateDatabaseZonal | CreateDatabaseZonal | Creates a database of an edge cluster for PolarDB on ENS. |
| GrantAccountPrivilegeZonal | GrantAccountPrivilegeZonal | Modifies the account permissions on a PolarDB for Xscale cluster. |
| ModifyDBDescriptionZonal | ModifyDBDescriptionZonal | Modifies the database description of an edge cluster for PolarDB on ENS. |
| CheckDBNameZonal | CheckDBNameZonal | Checks the name of a database in an edge cluster for PolarDB on ENS. |
| DescribeDBClusterVersionZonal | DescribeDBClusterVersionZonal | Queries the version of a PolarDB edge cluster. |
| ModifyDBClusterEndpointZonal | ModifyDBClusterEndpointZonal | Modifies the connection string for an edge cluster for PolarDB on ENS. |
| ModifyAccountPasswordZonal | ModifyAccountPasswordZonal | Modifies the password of an account in a PolarDB for Xscale cluster. |
| DeleteAccountZonal | DeleteAccountZonal | Deletes an account from an edge cluster for PolarDB on ENS. |
| ModifyAccountDescriptionZonal | ModifyAccountDescriptionZonal | Modifies the description of a PolarDB on ENS account. |
| ResetAccountZonal | ResetAccountZonal | Resets an account in a PolarDB for Xscale cluster. |
| CreateDBClusterEndpointZonal | CreateDBClusterEndpointZonal | Edge Cloud API: Create Link Address |
| RevokeAccountPrivilegeZonal | RevokeAccountPrivilegeZonal | Revokes permissions from an account. |
| ModifyDBClusterDescriptionZonal | ModifyDBClusterDescriptionZonal | Modifies the description of a cluster. |
| DescribeDatabasesZonal | DescribeDatabasesZonal | Describes the databases in a PolarDB on ENS cluster. |
| DescribeDBClusterEndpointsZonal | DescribeDBClusterEndpointsZonal | Queries the endpoints of an edge cluster for PolarDB on ENS. |
| DeleteDatabaseZonal | DeleteDatabaseZonal | Deletes a database from a PolarDB edge cloud cluster. |
| FailoverDBClusterZonal | FailoverDBClusterZonal | Initiates a zonal failover for a PolarDB cluster, promoting a secondary node to primary. |
| DescribeDbClusterAttributeZonal | DescribeDbClusterAttributeZonal | Queries the attributes of an PolarDB on ENS cluster. |
| CheckAccountNameZonal | CheckAccountNameZonal | Checks a PolarDB account name. |
| DescribeDBClustersZonal | DescribeDBClustersZonal | Lists the PolarDB clusters in MyBase. |
Others
|
API |
Title |
Description |
| AbortDBClusterMigration | AbortDBClusterMigration | Aborts an upgrade or migration task. |
| AddEncryptionDBRolePrivilege | AddEncryptionDBRolePrivilege | Grants permissions to a role. |
| AddFirewallRules | AddFirewallRules | Adds SQL firewall rules. |
| AddPolarFsQuota | AddPolarFsQuota | Adds a new directory quota rule to a PolarFileSystem (PolarFS) instance. |
| AddSQLRateLimitingRules | AddSQLRateLimitingRules | Adds SQL throttling rules. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
| CancelCronJobPolicyServerless | CancelCronJobPolicyServerless | Cancels an auto triggered task policy. |
| CancelPolarFsFileQuota | CancelPolarFsFileQuota | Deletes quota rules for one or more file paths in a specified PolarFileSystem (PolarFS) instance. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| CheckConnectionString | CheckConnectionString | Checks the connection string of a cluster. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role has been created. |
| ClonePolarFsBasicSnapshot | ClonePolarFsBasicSnapshot | Clones a file or directory snapshot for a PolarFileSystem (PolarFS) Basic Edition instance. |
| CloseDBClusterMigration | CloseDBClusterMigration | Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster. |
| ContinueDBClusterMigration | ContinueDBClusterMigration | Continues the current migration or upgrade task. |
| CreateAINodes | CreateAINodes | Creates AI nodes. |
| CreateActivationCode | CreateActivationCode | Generates activation codes for the lightweight version. |
| CreateCronJobPolicyServerless | CreateCronJobPolicyServerless | Creates a scheduled task policy for a serverless cluster. |
| CreateDatabase | CreateDatabase | Creates a database for a PolarDB cluster. |
| CreateExtensions | CreateExtensions | Creates one or more extensions. |
| CreateGlobalDataNetwork | CreateGlobalDataNetwork | Creates a new PolarFS Global Data Network (GDN). |
| CreateGlobalDatabaseNetwork | CreateGlobalDatabaseNetwork | Creates a new global database network (GDN). |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| CreateNetworkChannel | CreateNetworkChannel | Creates a network channel. |
| CreateOrGetVirtualLicenseOrder | CreateOrGetVirtualLicenseOrder | Creates or obtains a virtual license order. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Ccreates a service-linked role. |
| DeleteAIDBCluster | DeleteAIDBCluster | Deletes an AI cluster instance. |
| DeleteAINodes | DeleteAINodes | Deletes child nodes of an AI instance. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| DeleteDBEndpointAddress | DeleteDBEndpointAddress | Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a PolarDB cluster. |
| DeleteEncryptionDBRolePrivilege | DeleteEncryptionDBRolePrivilege | Deletes a role. |
| DeleteExtensions | DeleteExtensions | Deletes an extension. |
| DeleteFirewallRules | DeleteFirewallRules | Deletes the specified SQL firewall rules. |
| DeleteGlobalDataNetwork | DeleteGlobalDataNetwork | Deletes a specific PolarFileSystem (PolarFS) Global Database Network (GDN). |
| DeleteGlobalDatabaseNetwork | DeleteGlobalDatabaseNetwork | Deletes a global database network (GDN). |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DeleteNetworkChannel | DeleteNetworkChannel | Deletes a network channel. |
| DeletePolarFsQuota | DeletePolarFsQuota | Deletes one or more quota rules from a specified PolarFileSystem (PolarFS) instance. |
| DeleteSQLRateLimitingRules | DeleteSQLRateLimitingRules | Deletes SQL throttling rules. |
| DescribeAIDBClusterAttribute | DescribeAIDBClusterAttribute | View the details of a custom instance |
| DescribeAIDBClusterPerformance | DescribeAIDBClusterPerformance | Retrieves the performance metrics of an AI container. |
| DescribeAIDBClusterTaskLogFiles | DescribeAIDBClusterTaskLogFiles | Queries the logs of model operators. |
| DescribeAIDBClusterTaskMetrics | DescribeAIDBClusterTaskMetrics | Queries the metrics of model operators. |
| DescribeAIDBClusters | DescribeAIDBClusters | Returns a list of custom clusters. |
| DescribeActivationCodeDetails | DescribeActivationCodeDetails | Queries the details of an activation code. |
| 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. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the Operations and Maintenance (O&M) configuration for a user, including the active O&M window. |
| DescribeApplicationServerlessConf | DescribeApplicationServerlessConf | Queries the Serverless configuration for a PolarDB application. |
| DescribeAvailableCrossRegions | DescribeAvailableCrossRegions | Retrieves a list of regions available for cross-region backup. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the automatic backup policy of a PolarDB cluster. |
| DescribeBackupRegions | DescribeBackupRegions | Queries the regions that store backup sets. |
| DescribeColdStorageInstance | DescribeColdStorageInstance | Queries the details of 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. |
| DescribeDBClusterAccessWhitelist | DescribeDBClusterAccessWhitelist | Queries the IP address whitelists and security groups of a PolarDB 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. |
| DescribeDBClusterEncryptionKey | DescribeDBClusterEncryptionKey | Queries the key usage details for a specified PolarDB cluster. |
| DescribeDBClusterMonitor | DescribeDBClusterMonitor | Queries the interval at which the monitoring data of a PolarDB cluster is collected. |
| DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | Queries information about database endpoints. |
| DescribeDBClusterProxy | DescribeDBClusterProxy | Queries the details of a database cluster proxy. |
| DescribeDBClusterSSL | DescribeDBClusterSSL | Queries the SSL settings of a PolarDB cluster. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance monitoring data for a compute node. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for Oracle cluster. |
| DescribeDBLogFiles | DescribeDBLogFiles | Queries the logs of a PolarDB cluster, such as primary/secondary failover logs. |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries the available minor engine versions. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of PolarProxy. |
| DescribeDasConfig | DescribeDasConfig | Queries the configurations of a cluster in Database Autonomy Service (DAS). |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the information about the backup sets in a released PolarDB cluster. |
| DescribeEncryptionDBRolePrivilege | DescribeEncryptionDBRolePrivilege | Queries a list of permissions for a database role. |
| DescribeEncryptionDBSecret | DescribeEncryptionDBSecret | Queries encryption key information. |
| DescribeExtensions | DescribeExtensions | Retrieves the details of extensions. |
| DescribeFirewallRules | DescribeFirewallRules | Describes SQL firewall rules. |
| DescribeGlobalDataNetworkList | DescribeGlobalDataNetworkList | Queries the details of PolarFileSystem (PolarFS) Global Data Networks (GDNs) across gemini 建议 across，更地道 inall regions in your account. |
| DescribeGlobalDatabaseNetwork | DescribeGlobalDatabaseNetwork | Queries the information about a Global Database Network (GDN). |
| DescribeGlobalDatabaseNetworks | DescribeGlobalDatabaseNetworks | Describes all global database networks (GDNs) in your account. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| DescribeHALogs | DescribeHALogs | Queries high availability (HA) logs for an instance. |
| DescribeHistoryEvents | DescribeHistoryEvents | Lists the historical events in Event Center. |
| DescribeHistoryTasks | DescribeHistoryTasks | Retrieves a list of historical administrative tasks for PolarDB for MySQL instances, such as parameter changes, and instance restarts. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries task statistics in Task Center. |
| DescribeLicenseOrderDetails | DescribeLicenseOrderDetails | Queries the details of a license order. |
| DescribeLicenseOrders | DescribeLicenseOrders | This operation queries a list of license orders. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | Queries the available time range to recover from a backup. |
| DescribeLogBackupPolicy | DescribeLogBackupPolicy | Queries the data retention policy for the log backups of a PolarDB cluster. |
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the modification history of parameters. |
| DescribeNetworkChannel | DescribeNetworkChannel | Queries network channels. |
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePolarAgentChatRecords | DescribePolarAgentChatRecords | Queries the chat records of a specified session. |
| DescribePolarAgentSessionStatus | DescribePolarAgentSessionStatus | Queries the status of a session. |
| DescribePolarAgentUserSessions | DescribePolarAgentUserSessions | Queries historical session records. |
| DescribePolarFsAttribute | DescribePolarFsAttribute | Queries the details of a PolarFileSystem (PolarFS) instance. |
| DescribePolarFsQuota | DescribePolarFsQuota | Retrieves all quota rules for a specified PolarFileSystem (PolarFS) instance. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | Describes a list of VPCs. |
| DescribeRegions | DescribeRegions | Queries the regions and zones that are supported by PolarDB. |
| DescribeResourcePackages | DescribeResourcePackages | Describes cross-cloud resource plans. |
| 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 | Disables the Orca (Redis-compatible) feature for a PolarDB cluster. |
| EnableDBClusterOrca | EnableDBClusterOrca | Enables the Orca (Redis-compatible) feature for a PolarDB cluster. |
| EnableSQLRateLimitingRules | EnableSQLRateLimitingRules | Enables or disables SQL throttling rules. |
| ExecuteCrossCloudOpenAPI | ExecuteCrossCloudOpenAPI | Calls a cross-cloud OpenAPI. |
| FailoverDBCluster | FailoverDBCluster | Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster. |
| GenerateUpgradeReportForSyncClone | GenerateUpgradeReportForSyncClone | Generates a report for a pre-upgrade check. |
| GetPolarAgent | GetPolarAgent | Creates a chat record. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster. |
| 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. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a database account for a specified PolarDB cluster. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Configures the operations and maintenance (O&M) settings for a user. These settings include the active maintenance window. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\&M events for an instance. |
| ModifyApplicationServerlessConf | ModifyApplicationServerlessConf | Modifies the Serverless configuration of a PolarDB application. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy for a PolarDB cluster. |
| ModifyCronJobPolicyServerless | ModifyCronJobPolicyServerless | Modifies the policy for a scheduled task. |
| ModifyDBClusterAuditLogCollector | ModifyDBClusterAuditLogCollector | Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer. |
| ModifyDBClusterMigrationEndpoint | ModifyDBClusterMigrationEndpoint | Modifies the source and target instances of a Data Transmission Service (DTS) task. |
| ModifyDBClusterMonitor | ModifyDBClusterMonitor | Modifies the interval at which the monitoring data of a PolarDB cluster is collected. |
| ModifyDBClusterSSL | Configure cluster SSL | Enables or disables SSL encryption for a PolarDB cluster, or updates its CA certificate. |
| ModifyDBClusterServerlessConf | ModifyDBClusterServerlessConf | Modifies the configurations of a serverless cluster. |
| ModifyDBClusterVpc | ModifyDBClusterVpc | Modifies the vSwitch parameters for a cluster. |
| ModifyDBNodeConfig | ModifyDBNodeConfig | Modifies the configuration of a node in a PolarDB cluster. |
| ModifyDBNodeDescription | ModifyDBNodeDescription | Modifies the name of a node in a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| ModifyDBNodeSccMode | ModifyDBNodeSccMode | Modifies the Snapshot Consistency Cluster (SCC) mode for a specified node in a PolarDB cluster. |
| ModifyEncryptionDBRolePrivilege | ModifyEncryptionDBRolePrivilege | Modifies role permissions. |
| ModifyEncryptionDBSecret | ModifyEncryptionDBSecret | Modifies an encryption policy. |
| ModifyFirewallRules | ModifyFirewallRules | Modifies the configuration of the SQL firewall. |
| ModifyGlobalDatabaseNetwork | ModifyGlobalDatabaseNetwork | Modifies a global database network (GDN). |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup retention policy for a PolarDB cluster. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
| ModifyResourcePackage | ModifyResourcePackage | Modifies a cross-cloud resource plan. |
| ModifySQLRateLimitingRules | ModifySQLRateLimitingRules | Modifies SQL throttling rules. |
| ModifyScheduleTask | ModifyScheduleTask | Modifies the specified scheduled task. |
| ReactivateDBClusterBackup | ReactivateDBClusterBackup | Reactivates the backup feature. |
| RemoveDBClusterFromGDN | RemoveDBClusterFromGDN | Removes a secondary cluster from a global database network (GDN). |
| ResetAccount | ResetAccount | Resets the permissions of a privileged account for a PolarDB cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for a PolarDB database account. |
| ResetGlobalDatabaseNetwork | ResetGlobalDatabaseNetwork | Resets the network of a secondary cluster in a Global Database Network (GDN). |
| RestartDBLink | RestartDBLink | Restarts database links. |
| SetPolarFsFileQuota | SetPolarFsFileQuota | Sets file quota rules for a specified directory in a PolarFileSystem (PolarFS) instance. |
| SwitchOverGlobalDatabaseNetwork | SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a global database network (GDN). |
| UpdateExtensions | UpdateExtensions | Updates one or more extensions. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |