This product(
polardb/2017-08-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Sales management
| API | Title | Description |
|---|---|---|
| CreateStoragePlan | CreateStoragePlan | Purchases a storage plan. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Queries the auto-renewal attributes of a subscription PolarDB cluster. |
| DescribeClassList | DescribeClassList | Queries the specifications of a cluster. |
| DescribeDBClusterAvailableResources | DescribeDBClusterAvailableResources | Queries available resources in a PolarDB cluster. |
| EvaluateRegionResource | EvaluateRegionResource | Evaluates available resources. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Modifies the auto-renewal attributes of a subscription PolarDB cluster. |
| TransformDBClusterPayType | TransformDBClusterPayType | Changes the billing method of a PolarDB cluster. |
Cluster management
| API | Title | Description |
|---|---|---|
| CreateDBCluster | CreateDBCluster | Create Database Cluster |
| DeleteDBCluster | DeleteDBCluster | Releases a pay-as-you-go PolarDB cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries PolarDB clusters or the clusters that can be accessed by an authorized RAM user. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries information about a PolarDB cluster. |
| DescribeDBClusterServerlessConf | DescribeDBClusterServerlessConf | Query serverless configuration. |
| 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. |
| DescribeTasks | DescribeTasks | Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks. |
| DescribeVSwitches | DescribeVSwitches | Queries a vSwitch. |
| ModifyDBCluster | ModifyDBCluster | Modifies the configurations of a PolarDB for MySQL cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the name of a PolarDB cluster. |
| ModifyDBClusterDeletion | ModifyDBClusterDeletion | Enables or disables the cluster lock feature. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the maintenance window of a PolarDB cluster. |
| EnableDBClusterServerless | EnableDBClusterServerless | Enables a stable serverless cluster. |
| DisableDBClusterServerless | DisableDBClusterServerless | Disables a stable serverless cluster. |
| ModifyDBClusterServerlessConf | ModifyDBClusterServerlessConf | Modifies the configurations of a serverless cluster. |
| ModifyDBClusterStorageSpace | ModifyDBClusterStorageSpace | Changes the storage capacity of a pay-as-you-go cluster of Enterprise Edition or a cluster of Standard Edition. |
| ManuallyStartDBCluster | ManuallyStartDBCluster | Manually starts a cluster. |
High-availability deployment architecture
| API | Title | Description |
|---|---|---|
| ModifyDBClusterPrimaryZone | ModifyDBClusterPrimaryZone | Changes the primary zone of a PolarDB cluster. |
| FailoverDBCluster | FailoverDBCluster | Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster. |
Engine versions management
| API | Title | Description |
|---|---|---|
| DescribeDBClusterVersion | DescribeDBClusterVersion | Queries the information about the database engine version of a PolarDB for MySQL cluster. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |
Whitelist management
| API | Title | Description |
|---|---|---|
| DescribeDBClusterAccessWhitelist | DescribeDBClusterAccessWhitelist | Queries the IP address whitelists and security groups of a PolarDB cluster. |
| ModifyDBClusterAccessWhitelist | ModifyDBClusterAccessWhitelist | Creates or modifies the whitelists (IP whitelists and security groups) of a specified cluster. |
Global IP whitelist template management
| API | Title | Description |
|---|---|---|
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| 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. |
SSL encryption
| API | Title | Description |
|---|---|---|
| DescribeDBClusterSSL | DescribeDBClusterSSL | Queries the Secure Sockets Layer (SSL) settings of a PolarDB cluster. |
| ModifyDBClusterSSL | ModifyDBClusterSSL | Enables or disables the SSL encryption feature for a PolarDB cluster, or updates the CA certificate of the cluster. |
TDE
| API | Title | Description |
|---|---|---|
| CheckKMSAuthorized | CheckKMSAuthorized | Queries whether a user is authorized to use Key Management Service (KMS). |
| DescribeDBClusterTDE | DescribeDBClusterTDE | Queries the transparent data encryption (TDE) settings of a PolarDB cluster. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster. |
| ModifyDBClusterTDE | ModifyDBClusterTDE | Enables the transparent data encryption (TDE) feature for a PolarDB cluster. |
Node management
| API | Title | Description |
|---|---|---|
| CreateDBNodes | CreateDBNodes | Adds a read-only node to a PolarDB cluster. |
| DeleteDBNodes | DeleteDBNodes | Deletes a read-only node from a PolarDB cluster. |
| ModifyDBNodeClass | ModifyDBNodeClass | Changes the node specifications of a PolarDB cluster. |
| ModifyDBNodesClass | ModifyDBNodesClass | Changes the specifications of a node in a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| RestartDBNode | RestartDBNode | Restarts a node in a PolarDB cluster. |
| TempModifyDBNode | TempModifyDBNode | Temporarily changes the node configurations. |
| TempModifyDBNode | TempModifyDBNode |
Cluster parameters management
| API | Title | Description |
|---|---|---|
| CreateParameterGroup | CreateParameterGroup | Creates a parameter template. |
| DescribeDBClusterParameters | DescribeDBClusterParameters | Queries the parameters of a PolarDB cluster. |
| DescribeDBNodesParameters | DescribeDBNodesParameters | Queries the parameters of a specified node in a cluster. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the default parameters in a cluster. |
| DescribeParameterGroups | DescribeParameterGroups | Queries parameter templates that are available in a specified region. |
| DescribeParameterGroup | DescribeParameterGroup | Queries the information about a parameter template. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a parameter template from a PolarDB cluster. |
| ModifyDBClusterAndNodesParameters | ModifyDBClusterAndNodesParameters | Modifies cluster parameters and applies them to specified nodes. |
| ModifyDBClusterParameters | ModifyDBClusterParameters | Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster. |
| ModifyDBNodesParameters | ModifyDBNodesParameters | Modifies the parameter settings of a node and applies the new settings to another specified node. |
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. |
| DescribeDBClusterEndpoints | DescribeDBClusterEndpoints | Queries the endpoints 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. |
| 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 | Releases a custom cluster endpoint 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. |
Logs management
| API | Title | Description |
|---|---|---|
| DescribeSlowLogRecords | DescribeSlowLogRecords | Slow Log Details |
| DescribeSlowLogs | DescribeSlowLogs | Queries the statistics about the slow query logs of a PolarDB cluster. |
| DescribeDBClusterAuditLogCollector | DescribeDBClusterAuditLogCollector | Queries the SQL collection features of a PolarDB cluster, such as audit logs and SQL Explorer and Audit. |
| ModifyDBClusterAuditLogCollector | ModifyDBClusterAuditLogCollector | Enables or disables SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer. By default, when you call this operation to enable SQL collector for a PolarDB cluster in a region that supports DAS Enterprise Edition, the latest DAS Enterprise Edition supported by the region is enabled. For information about the database engines and regions supported by each DAS Enterprise edition, see the "Supported databases and regions" section of the "Editions and supported features" topic. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates a database account for a PolarDB cluster. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| DescribeAccounts | DescribeAccounts | Queries information about a database account of a PolarDB cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account of a PolarDB cluster. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a PolarDB cluster. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes access permissions on one or more databases for a standard account of a PolarDB cluster. |
| ResetAccount | ResetAccount | Resets the permissions of a privileged account for a PolarDB cluster. |
| DeleteAccount | DeleteAccount | Deletes a database account for a PolarDB cluster. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a database account for a specified PolarDB cluster. |
Database management
| API | Title | Description |
|---|---|---|
| CreateDatabase | CreateDatabase | Creates a database for a PolarDB cluster. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a PolarDB cluster. |
| DescribeDatabases | DescribeDatabases | Queries the information about databases in a PolarDB cluster. |
| DescribeCharacterSetName | DescribeCharacterSetName | Queries character sets that are supported by a PolarDB for MySQL cluster. |
| CheckDBName | CheckDBName | Checks whether a database name is valid or whether the name is already used by another database in the current cluster. |
| DescribeDBInitializeVariable | DescribeDBInitializeVariable | Queries attributes such as character sets and collations supported by a database in a PolarDB cluster. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of a database in a PolarDB for MySQL cluster. |
Global Database Network (GDN) management
| API | Title | Description |
|---|---|---|
| CreateGlobalDatabaseNetwork | CreateGlobalDatabaseNetwork | Creates a global database network (GDN). |
| DeleteGlobalDatabaseNetwork | DeleteGlobalDatabaseNetwork | Deletes a global database network (GDN). |
| 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. |
| ModifyGlobalDatabaseNetwork | ModifyGlobalDatabaseNetwork | Modifies a global database network (GDN). |
| RemoveDBClusterFromGDN | RemoveDBClusterFromGDN | Removes secondary clusters from a Global Database Network (GDN). |
| SwitchOverGlobalDatabaseNetwork | SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a global database network (GDN). |
| ResetGlobalDatabaseNetwork | ResetGlobalDatabaseNetwork | Rebuilds a secondary cluster in a Global Database Network (GDN). |
Backup management
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Creates a full snapshot backup for a PolarDB cluster. |
| DescribeBackups | DescribeBackups | Queries the backup details of a PolarDB cluster. |
| DescribeBackupTasks | DescribeBackupTasks | Queries the details of backup tasks of a cluster. |
| DescribeBackupLogs | DescribeBackupLogs | Queries backup logs and the URLs to download the backup logs. |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the information about the backup sets in a released PolarDB cluster. |
| DescribeDBClustersWithBackups | DescribeDBClustersWithBackups | Queries the information about PolarDB clusters that contain backup sets in a region. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| Backup policy | Backup policy | |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the automatic backup policy of a PolarDB cluster. |
| DescribeLogBackupPolicy | DescribeLogBackupPolicy | Queries the retention policy of log backups in a PolarDB cluster. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy of a PolarDB cluster. |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the retention policy of the log backups in a PolarDB cluster. |
Restore management
| API | Title | Description |
|---|---|---|
| DescribeMetaList | DescribeMetaList | Queries the details of the databases or tables that can be restored. |
| RestoreTable | RestoreTable | Restores PolarDB databases and tables. |
Data migration from RDS
| API | Title | Description |
|---|---|---|
| DescribeDBClusterMigration | DescribeDBClusterMigration | The ID of the synchronous task. |
| ModifyDBClusterMigration | ModifyDBClusterMigration | Switches or rolls back the task that migrates data from an ApsaraDB for RDS instance to a PolarDB cluster. |
| CloseDBClusterMigration | CloseDBClusterMigration | Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster. |
Tag management
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates tags for a PolarDB cluster. |
| UntagResources | UntagResources | Unbinds tags from PolarDB clusters. |
| ListTagResources | ListTagResources | Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added. |
Pending events management
| API | Title | Description |
|---|---|---|
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Queries the numbers of pending events of different task types. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
Scheduled tasks management
| API | Title | Description |
|---|---|---|
| DescribeScheduleTasks | DescribeScheduleTasks | Queries the details of all scheduled tasks. |
| CancelScheduleTasks | CancelScheduleTasks | Cancels scheduled tasks that are not yet started. |
Masking rules management
| API | Title | Description |
|---|---|---|
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| ModifyMaskingRules | ModifyMaskingRules | Modifies or adds a data masking rule. |
| DeleteMaskingRules | DeleteMaskingRules | Deletes a data masking rule. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeDBNodePerformance | DescribeDBNodePerformance | Queries the performance data of a node in a PolarDB cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of a PolarDB cluster. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of PolarProxy. |
| DescribeDBClusterMonitor | DescribeDBClusterMonitor | Queries the interval at which the monitoring data of a PolarDB cluster is collected. |
| ModifyDBClusterMonitor | ModifyDBClusterMonitor | Modifies the interval at which the monitoring data of a PolarDB cluster is collected. |
PolarDB for AI
| API | Title | Description |
|---|---|---|
| DescribeAITaskStatus | DescribeAITaskStatus | Queries the status of the PolarDB for AI feature. |
| OpenAITask | OpenAITask | Enables the PolarDB for AI feature for a cluster. |
| CloseAITask | CloseAITask | Disables the PolarDB for AI feature for a cluster. |
DBLink
| API | Title | Description |
|---|---|---|
| CreateDBLink | CreateDBLink | Creates a database link. |
| RestartDBLink | RestartDBLink | Restarts database links. |
| DeleteDBLink | DeleteDBLink | Deletes a database link from a PolarDB for Oracle cluster. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for Oracle cluster. |
Connection diagnosis
| API | Title | Description |
|---|---|---|
| DescribeDBClusterConnectivity | DescribeDBClusterConnectivity | Queries whether the source IP address can access a cluster. |
Others
| API | Title | Description |
|---|---|---|
| DescribeDasConfig | DescribeDasConfig | Queries the configurations of a cluster in Database Autonomy Service (DAS). |