API standards and multilingual preset SDKs
The OpenAPI of this product (polardb/2017-08-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
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. |
| DescribeDBClusterAvailableResources | Queries the available resources of a PolarDB cluster | Queries the available resources of a PolarDB cluster. |
| 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. |
| DescribeZones | DescribeZones | Queries the available zones. |
| DescribeVSwitchList | DescribeVSwitchList | Retrieves information about vSwitches. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | Describes a list of VPCs. |
| DescribeVSwitches | DescribeVSwitches | Queries one or more vSwitches. |
| DescribeVpcs | DescribeVpcs | Queries one or more VPCs. |
Cluster management
|
API |
Title |
Description |
| CreateDBCluster | Create a cluster | Creates a PolarDB cluster. |
| DeleteDBCluster | DeleteDBCluster | Deletes a pay-as-you-go PolarDB cluster. |
| DescribeDBClusters | Query cluster list | Queries the details of PolarDB clusters or clusters authorized by RAM authorization. |
| DescribeDBClusterAttribute | Query detailed attributes of a polarDB cluster | Queries the attribute information of a cluster. |
| DescribeDBClusterServerlessConf | DescribeDBClusterServerlessConf | Queries the configuration of a serverless cluster. |
| DescribePolarSQLCollectorPolicy | DescribePolarSQLCollectorPolicy | Checks whether the SQL Explorer feature is enabled for a target cluster. |
| DescribeDBClusterEncryptionKey | DescribeDBClusterEncryptionKey | Queries the key usage details for a specified PolarDB cluster. |
| ModifyDBCluster | Modify cluster feature configurations | 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 | Enable steady-state serverless | Enables steady-state serverless. |
| DisableDBClusterServerless | Disable steady-state serverless | Disables steady-state serverless. |
| CreateCronJobPolicyServerless | CreateCronJobPolicyServerless | Creates a scheduled task policy for a serverless cluster. |
| DescribeCronJobPolicyServerless | DescribeCronJobPolicyServerless | Queries the policies for automatically triggered tasks. |
| ModifyCronJobPolicyServerless | ModifyCronJobPolicyServerless | Modifies the policy for a scheduled task. |
| ModifyDBClusterServerlessConf | ModifyDBClusterServerlessConf | Modifies the configuration of a serverless cluster. |
| CancelCronJobPolicyServerless | CancelCronJobPolicyServerless | Cancels an auto triggered task policy. |
| ModifyDBClusterStorageSpace | ModifyDBClusterStorageSpace | This operation modifies the storage space for pay-as-you-go enterprise edition and standard edition clusters. |
| 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. |
| ModifyDBClusterVpc | ModifyDBClusterVpc | Modifies the vSwitch parameters for a cluster. |
| EnableDBClusterDynamoDB | EnableDBClusterDynamoDB | Enables DynamoDB compatibility. |
| DisableDBClusterDynamoDB | DisableDBClusterDynamoDB | Disables DynamoDB compatibility. |
| EnableDBClusterOrca | EnableDBClusterOrca | Enables the Orca (Redis-compatible) feature for a PolarDB cluster. |
| DisableDBClusterOrca | DisableDBClusterOrca | Disables the Orca (Redis-compatible) feature for a PolarDB 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. |
| DescribeDBLogFiles | DescribeDBLogFiles | Queries the logs of a PolarDB cluster, such as primary/secondary failover logs. |
| DescribeHALogs | DescribeHALogs | Queries high availability (HA) logs for an instance. |
Kernel version management
|
API |
Title |
Description |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries the available minor engine versions. |
| DescribeDBClusterVersion | DescribeDBClusterVersion | Retrieves the details of the current kernel version for a PolarDB for MySQL cluster. |
Whitelist management
|
API |
Title |
Description |
| DescribeDBClusterAccessWhitelist | Query the IP whitelist of a cluster | Queries the IP whitelist and security groups that are allowed to access a database cluster. |
| ModifyDBClusterAccessWhitelist | Create or modify cluster whitelist | Creates or modifies the whitelist of a cluster, including the IP whitelist and security groups. |
Global IP whitelist template management
|
API |
Title |
Description |
| CreateGlobalSecurityIPGroup | Create a global whitelist | Creates a global IP whitelist template. |
| DescribeGlobalSecurityIPGroup | Query the list of global IP allowlist templates | Queries the list of global IP allowlist templates. |
| 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. |
SSL encryption
|
API |
Title |
Description |
| DescribeDBClusterSSL | Query SSL settings of a polarDB cluster | Queries the SSL settings of a PolarDB cluster. |
| ModifyDBClusterSSL | Set cluster SSL | Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster. |
TDE encryption
|
API |
Title |
Description |
| CheckKMSAuthorized | CheckKMSAuthorized | Checks whether a user is authorized to use Key Management Service (KMS). |
| DescribeDBClusterTDE | DescribeDBClusterTDE | Queries the transparent data encryption (TDE) settings for a specified PolarDB cluster. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Retrieves a list of Key Management Service (KMS) keys. |
| DescribeEncryptionDBSecret | DescribeEncryptionDBSecret | Queries encryption key information. |
| ModifyEncryptionDBSecret | ModifyEncryptionDBSecret | Modifies an encryption policy. |
| ModifyDBClusterTDE | ModifyDBClusterTDE | ModifyDBClusterTDE |
SQL firewall
|
API |
Title |
Description |
| EnableFirewallRules | EnableFirewallRules | Modifies the status of SQL firewall rules for a cluster. |
| AddFirewallRules | AddFirewallRules | Adds SQL firewall rules. |
| DescribeFirewallRules | DescribeFirewallRules | Describes SQL firewall rules. |
| ModifyFirewallRules | ModifyFirewallRules | Modifies the configuration of the SQL firewall. |
| DeleteFirewallRules | DeleteFirewallRules | Deletes the specified SQL firewall rules. |
SQL throttling
|
API |
Title |
Description |
| EnableSQLRateLimitingRules | EnableSQLRateLimitingRules | Enables or disables SQL throttling rules. |
| AddSQLRateLimitingRules | AddSQLRateLimitingRules | Adds SQL throttling rules. |
| DescribeSQLRateLimitingRules | DescribeSQLRateLimitingRules | Returns the details of SQL throttling rules. |
| ModifySQLRateLimitingRules | ModifySQLRateLimitingRules | Modifies SQL throttling rules. |
| DeleteSQLRateLimitingRules | DeleteSQLRateLimitingRules | Deletes SQL throttling rules. |
Node management
|
API |
Title |
Description |
| CreateDBNodes | Add read-only nodes to a polarDB cluster | Adds read-only nodes to a PolarDB cluster. |
| DeleteDBNodes | DeleteDBNodes | Deletes read-only nodes from a PolarDB cluster. |
| ModifyDBNodeDescription | ModifyDBNodeDescription | Modifies the name of a node in a PolarDB cluster. |
| ModifyDBNodeConfig | ModifyDBNodeConfig | Modifies the configuration of a node in a PolarDB cluster. |
| ModifyDBNodeSccMode | ModifyDBNodeSccMode | Modifies the Snapshot Consistency Cluster (SCC) mode for a specified node in a PolarDB cluster. |
| ModifyDBNodeClass | Change polarDB cluster node specifications | Changes the node specifications of a PolarDB cluster. |
| ModifyDBNodesClass | ModifyDBNodesClass | Modifies the specifications of a single node in a PolarDB cluster. |
| RestartDBNode | RestartDBNode | Restarts a node of a PolarDB cluster. |
| TempModifyDBNode | TempModifyDBNode | Temporarily Modifies the configuration of a node. |
Parameter 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 | Retrieves the details of a specified parameter template. |
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the modification history of parameters. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a PolarDB parameter template. |
| ModifyDBClusterAndNodesParameters | ModifyDBClusterAndNodesParameters | Modify cluster parameters and apply them 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. |
Endpoint management
|
API |
Title |
Description |
| CheckConnectionString | CheckConnectionString | Checks the connection string of a cluster. |
| CreateDBClusterEndpoint | Create a custom cluster endpoint | 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. |
| DescribeDBClusterProxy | DescribeDBClusterProxy | Queries a database cluster proxy. |
| DescribeDBClusterEndpoints | DescribeDBClusterEndpoints | Queries the endpoints of a PolarDB cluster. |
| DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | Queries database endpoints. |
| 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 connection address of a PolarDB cluster. The address can be a primary address, default cluster address, custom cluster address, or private domain name. |
| 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. |
Log 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. |
| DescribeDBClusterAuditLogCollector | DescribeDBClusterAuditLogCollector | Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer. |
| ModifyDBClusterAuditLogCollector | ModifyDBClusterAuditLogCollector | Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer. |
Account management
|
API |
Title |
Description |
| CreateAccount | Create a polarDB database account | Creates a PolarDB database account. |
| DescribeAccounts | DescribeAccounts | Queries a database account of a PolarDB cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a PolarDB database account. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes access permissions on a database from a PolarDB standard account. |
| ModifyAccountLockState | ModifyAccountLockState | Changes the lock status of a PolarDB database account. |
| ResetAccount | ResetAccount | Resets the permissions of a privileged account for a PolarDB cluster. |
| DeleteAccount | DeleteAccount | Deletes a PolarDB database account. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for 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. |
Global database network (GDN)
|
API |
Title |
Description |
| CreateGlobalDatabaseNetwork | CreateGlobalDatabaseNetwork | Creates a new global database network (GDN). |
| DeleteGlobalDatabaseNetwork | DeleteGlobalDatabaseNetwork | Deletes a global database network (GDN). |
| DescribeGlobalDatabaseNetwork | DescribeGlobalDatabaseNetwork | Retrieves details for a Global Database Network (GDN). |
| DescribeGlobalDatabaseNetworks | DescribeGlobalDatabaseNetworks | View details for all Global Database Networks (GDNs) in your account. |
| ModifyGlobalDatabaseNetwork | ModifyGlobalDatabaseNetwork | Modifies a global database network (GDN). |
| RemoveDBClusterFromGDN | RemoveDBClusterFromGDN | Removes a secondary cluster from a Global Database Network (GDN). |
| ResetGlobalDatabaseNetwork | ResetGlobalDatabaseNetwork | Resets the network of a secondary cluster in a Global Database Network (GDN). |
Backup management
|
API |
Title |
Description |
| CreateBackup | Create a full snapshot backup for a polarDB cluster | Creates a full snapshot backup for a PolarDB cluster. |
| DescribeBackups | View backup set list | Queries the backup information of 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 PolarDB clusters in a region that have backup sets. |
| DescribeBackupRegions | DescribeBackupRegions | Queries the regions that store backup sets. |
| DescribeAvailableCrossRegions | DescribeAvailableCrossRegions | Retrieves a list of regions available for cross-region backup. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | Queries the available time range to recover from a backup. |
| Backup policy | Backup policy | |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the automatic backup policy of a PolarDB cluster. |
| DescribeLogBackupPolicy | DescribeLogBackupPolicy | Queries the data retention policy for the log backups of a PolarDB cluster. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy for a PolarDB cluster. |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup retention policy for a PolarDB cluster. |
| Backup policy | Backup policy |
Database and table restoration
|
API |
Title |
Description |
| DescribeMetaList | DescribeMetaList | Queries recoverable databases and tables. |
| RestoreTable | RestoreTable | Restores databases or tables to a PolarDB cluster. |
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. |
| ContinueDBClusterMigration | ContinueDBClusterMigration | Continues the current migration or upgrade task. |
| ModifyDBClusterMigrationEndpoint | ModifyDBClusterMigrationEndpoint | Modifies the source and target instances of a Data Transmission Service (DTS) task. |
| CloseDBClusterMigration | CloseDBClusterMigration | Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster. |
| AbortDBClusterMigration | AbortDBClusterMigration | Aborts an upgrade or migration task. |
Tag management
|
API |
Title |
Description |
| ListTagResourcesForRegion | ListTagResourcesForRegion | Queries the tags that are attached to resources in a specified region. |
Pending event management
|
API |
Title |
Description |
| DescribeHistoryEvents | DescribeHistoryEvents | Lists the historical events in Event Center. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Configures the operations and maintenance (O&M) settings for a user. These settings include the active maintenance window. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the Operations and Maintenance (O&M) configuration for a user, including the active O&M window. |
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Retrieves a count of pending events for various task types. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries operation and maintenance events for instances. |
Scheduled task management
|
API |
Title |
Description |
| DescribeHistoryTasks | DescribeHistoryTasks | Retrieves a list of historical administrative tasks for PolarDB for MySQL instances, such as parameter changes, and instance restarts. |
| DescribeScheduleTasks | DescribeScheduleTasks | Retrieves the details of all scheduled tasks. |
| ModifyScheduleTask | ModifyScheduleTask | Modifies the specified scheduled task. |
| CancelScheduleTasks | CancelScheduleTasks | Cancels scheduled tasks that have not started. |
Data masking rule management
|
API |
Title |
Description |
| ModifyMaskingRules | ModifyMaskingRules | Modifies or creates data 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. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of PolarProxy. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance monitoring data for a compute node. |
| DescribeAIDBClusterPerformance | DescribeAIDBClusterPerformance | Retrieves the performance metrics of an AI container. |
PolarDB for AI
|
API |
Title |
Description |
| DescribeAITaskStatus | DescribeAITaskStatus | Retrieves the status of the PolarDB for AI feature. |
| OpenAITask | OpenAITask | Enables the PolarDB for AI feature. |
| CloseAITask | CloseAITask | Disables the PolarDB for AI feature. |
Network channel
|
API |
Title |
Description |
| CreateNetworkChannel | CreateNetworkChannel | Creates a network channel. |
| DescribeNetworkChannel | DescribeNetworkChannel | Queries network channels. |
| DeleteNetworkChannel | DeleteNetworkChannel | Deletes a network channel. |
DBLink
|
API |
Title |
Description |
| CreateDBLink | CreateDBLink | Creates a DBLink. |
| DeleteDBLink | DeleteDBLink | Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
Connection diagnostics
|
API |
Title |
Description |
| DescribeDBClusterConnectivity | DescribeDBClusterConnectivity | Checks whether a database cluster is accessible from a source IP address. |
Extensions
|
API |
Title |
Description |
| CreateExtensions | CreateExtensions | Creates one or more extensions. |
| DescribeExtensions | DescribeExtensions | Retrieves the details of extensions. |
| UpdateExtensions | UpdateExtensions | Updates one or more extensions. |
| DeleteExtensions | DeleteExtensions | Deletes an extension. |
Cold data archiving
|
API |
Title |
Description |
| CreateColdStorageInstance | CreateColdStorageInstance | Creates a cold storage instance. |
| DescribeColdStorageInstance | DescribeColdStorageInstance | Queries cold storage instances. |
PolarDB applications
|
API |
Title |
Description |
| DescribeApplications | DescribeApplications | Gets the list of applications for all PolarDB instances in a specified region. |
| CreateApplication | CreateApplication | Creates an application attached to a PolarDB instance. |
| DescribeApplicationAttribute | DescribeApplicationAttribute | Retrieves the details of a specific application in a PolarDB instance. |
| DescribeApplicationParameters | DescribeApplicationParameters | Retrieves the current parameters and template information for a specified application and its components. |
| DescribeApplicationServerlessConf | DescribeApplicationServerlessConf | Queries the Serverless configuration for a PolarDB application. |
| ModifyApplicationServerlessConf | ModifyApplicationServerlessConf | Modifies the Serverless configuration of a PolarDB application. |
| 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. |
| ApplyApplicationPrompts | ApplyApplicationPrompts | Applies prompts to an application instance. |
| CreateApplicationPrompt | CreateApplicationPrompt | Creates a Prompt for an Application. |
| DescribeApplicationPrompts | DescribeApplicationPrompts | Lists the Application Prompts for a specific Application. |
| ModifyApplicationPrompt | ModifyApplicationPrompt | Modifies the prompt for a specified application. |
| DeleteApplicationPrompt | DeleteApplicationPrompt | Deletes an application prompt. |
| AttachApplicationPolarFS | AttachApplicationPolarFS | Attaches a specified PolarLakeBase cold-storage instance to a PolarDB application. |
| DeleteApplication | DeleteApplication | Deletes the specified PolarDB application. This operation does not delete the associated PolarDB instance. |
| UpdateApplicationEnvironmentVariables | UpdateApplicationEnvironmentVariables | Updates the environment variables of an application. This operation is only supported for PolarClaw. |
| RemoveApplicationEnvironmentVariables | RemoveApplicationEnvironmentVariables | Removes application environment variables. This operation supports only PolarClaw. |
| DescribeApplicationLogs | AI application logs | Queries the log details of an AI application. |
| PolarClaw | PolarClaw | |
| GetPolarClawConfig | GetPolarClawConfig | Retrieves the PolarClaw configuration. |
| PatchPolarClawConfig | PatchPolarClawConfig | Updates a PolarClaw configuration. |
| DescribePolarClawAgents | List polarClaw agents | Queries all installed plug-ins and their status information under a specified application. |
| CreatePolarClawAgent | CreatePolarClawAgent | Creates a PolarClaw Agent. |
| UpdatePolarClawAgent | Update a polarClaw agent | Updates a PolarClaw agent. |
| UpgradePolarClawSkills | UpgradePolarClawSkills | Upgrades the PolarClaw feature. |
| DeletePolarClawAgent | DeletePolarClawAgent | This operation removes an agent and its associated bindings from a specified PolarClaw. |
| ListPolarClawBindings | ListPolarClawBindings | Lists PolarClaw bindings. |
| UnbindPolarClawAgent | UnbindPolarClawAgent | Unbinds a PolarClaw Agent. |
| BindPolarClawAgent | BindPolarClawAgent | Binds a PolarClaw Agent to a channel. |
| DescribePolarClawPlugins | DescribePolarClawPlugins | Lists all installed PolarClaw plugins and their status. |
| InstallPolarClawPlugin | InstallPolarClawPlugin | Installs a PolarClaw plugin. |
| EnablePolarClawPlugin | EnablePolarClawPlugin | Enables a PolarClaw plugin. |
| DisablePolarClawPlugin | DisablePolarClawPlugin | Disables the PolarClaw plugin. |
| UpgradePolarClawPlugin | UpgradePolarClawPlugin | Upgrades a PolarClaw plugin. |
| UninstallPolarClawPlugin | UninstallPolarClawPlugin | Uninstalls a PolarClaw plugin. |
| DescribePolarClawChannels | DescribePolarClawChannels | Lists all installed PolarClaw channels and their status information. |
| CreatePolarClawChannel | CreatePolarClawChannel | Creates a channel in PolarClaw. |
| EnablePolarClawChannel | EnablePolarClawChannel | Enables a PolarClaw channel. |
| DisablePolarClawChannel | DisablePolarClawChannel | This API disables a specified PolarClaw channel. |
| UpgradePolarClawChannel | UpgradePolarClawChannel | Upgrades a PolarClaw channel. |
| DeletePolarClawChannel | DeletePolarClawChannel | Deletes a PolarClaw Channel. |
| DescribePolarClawCronJobs | DescribePolarClawCronJobs | Query all or specific scheduled tasks in PolarClaw and their details. |
| CreatePolarClawCronJob | CreatePolarClawCronJob | Creates a PolarClaw scheduled task. |
| UpdatePolarClawCronJob | UpdatePolarClawCronJob | Updates the configuration of a PolarClaw scheduled task, allowing for partial field updates. |
| EnablePolarClawCronJob | EnablePolarClawCronJob | Enables a cron job in PolarClaw. |
| DisablePolarClawCronJob | DisablePolarClawCronJob | Disables a PolarClaw cron job. |
| RunPolarClawCronJob | RunPolarClawCronJob | Runs a PolarClaw cron job. |
| DeletePolarClawCronJob | DeletePolarClawCronJob | Deletes a PolarClaw cron job. |
| DescribePolarClawMCPServers | DescribePolarClawMCPServers | Lists all installed PolarClaw MCP services and their configurations. |
| AddPolarClawMCPServer | AddPolarClawMCPServer | Adds an MCP server to a specified PolarClaw application. |
| RemovePolarClawMCPServer | RemovePolarClawMCPServer | Deletes a PolarClaw MCP server. |
| PolarClaw | PolarClaw |
AI gateway
|
API |
Title |
Description |
| CreateGateway | CreateGateway | Creates a gateway instance. |
| DescribeGatewayList | DescribeGatewayList | Queries a list of gateway instances. |
| DescribeGatewayAttribute | DescribeGatewayAttribute | Viewing gateway instance details |
| DeleteGateway | DeleteGateway | Deletes a gateway instance. |
| CreateBudgetPolicy | CreateBudgetPolicy | Creates a budget policy. |
| DescribeBudgetPolicies | Query cost budget policies | Queries cost budget policies. |
| ModifyBudgetPolicy | ModifyBudgetPolicy | Modifies a budget policy. |
| DeleteBudgetPolicy | Delete a budget policy | Deletes a cost budget policy. |
| CreateRateLimitPolicy | CreateRateLimitPolicy | Creates a rate limiting policy. |
| DescribeRateLimitPolicy | DescribeRateLimitPolicy | Queries rate limit policies. |
| ModifyRateLimitPolicy | ModifyRateLimitPolicy | Modifies a rate limit policy. |
| DeleteRateLimitPolicy | Delete a throttling policy | Deletes a throttling policy. |
| CreateModelService | CreateModelService | Creates a model service. |
| DescribeModelServices | DescribeModelServices | List model services |
| ModifyModelService | ModifyModelService | Modifies a model service. |
| DeleteModelService | DeleteModelService | Deletes a specified model service. |
| CreateModelApi | CreateModelApi | Creates a model API. |
| DescribeModelApis | DescribeModelApis | Model Query API |
| ModifyModelApi | ModifyModelApi | Modifies a model API. |
| DeleteModelApi | DeleteModelApi | Deletes a model API. |
| CreateCostRule | CreateCostRule | Creates a cost rule. |
| DescribeCostRules | DescribeCostRules | Queries cost rules. |
| ModifyCostRule | ModifyCostRule | Modifies a cost rule. |
| DeleteCostRule | DeleteCostRule | Deletes a cost rule. |
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group. |
| DescribeConsumerGroups | DescribeConsumerGroups | Retrieves a list of consumer groups. |
| ModifyConsumerGroup | ModifyConsumerGroup | Modifies a consumer group. |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a consumer group. |
| CreateConsumer | CreateConsumer | Creates a consumer. |
| DescribeConsumers | Query consumer list | Queries the list of consumers. |
| ModifyConsumer | ModifyConsumer | Modifies the properties of a consumer. |
| DeleteConsumer | DeleteConsumer | Deletes a consumer. |
| ResetConsumerApiKey | ResetConsumerApiKey | Resets an api key. |
Polarlakebase instances
|
API |
Title |
Description |
| AddPolarFsQuota | AddPolarFsQuota | Adds a new directory quota rule to a Polarlakebase instance. |
| DescribePolarFsAttribute | Query polarLakebase cluster details | Retrieves the details of a PolarLakebase instance. |
| DescribePolarFsQuota | DescribePolarFsQuota | Retrieves all quota rules for a specified PolarFileSystem (PolarFS) instance. |
| SetPolarFsFileQuota | SetPolarFsFileQuota | Sets file quota rules for specific directories in a PolarFS instance. |
| CheckPolarFsQuotaConsistency | CheckPolarFsQuotaConsistency | Checks the consistency of quota settings in a PolarFS instance. |
| CancelPolarFsFileQuota | CancelPolarFsFileQuota | Deletes quota rules for one or more file paths within a specified Polarlakebase instance. |
| DeletePolarFsQuota | DeletePolarFsQuota | Deletes one or more quota rules from a specified Polarlakebase instance. |
| DescribeGlobalDataNetworkList | DescribeGlobalDataNetworkList | Retrieves details for Polarlakebase Global Data Networks (GDNs) across all regions in your account. |
| CreateGlobalDataNetwork | CreateGlobalDataNetwork | Create a new PolarLakeBase Global Data Network (GDN). |
| DeleteGlobalDataNetwork | DeleteGlobalDataNetwork | Deletes a Polarlakebase Global Data Network (GDN). |
| ClonePolarFsBasicSnapshot | ClonePolarFsBasicSnapshot | Clones a snapshot of a file or folder for a Basic Edition instance. |
| DescribePolarFsObjects | Query directory entries | Lists the files and subdirectories under a specified path. |
| CreatePolarFsObject | CreatePolarFsObject | Creates a new directory in a specified PolarFS instance. |
| MovePolarFsObjects | MovePolarFsObjects | Renames or moves files in a PolarFs instance. |
| DeletePolarFsObjects | DeletePolarFsObjects | Deletes objects from PolarLakebase. This operation supports only Basic Edition and Cold Storage Edition instances. |
| AddPolarFsPathMapping | AddPolarFsPathMapping | Adds a transparent acceleration path. |
| DeletePolarFsPathMapping | DeletePolarFsPathMapping | Deletes a path mapping for transparent acceleration. |
AI cluster
|
API |
Title |
Description |
| DescribeAvailableModels | Retrieve AI cluster model list | Retrieves the list of AI cluster models. |
| CreateAIDBClusterTask | Create a model operator instance | Creates a model creation operator instance. |
| DescribeAIDBClusterTasks | Query model operator list | Retrieves the list of model operators for a specified PolarDB database instance. |
| DescribeAIDBClusters | DescribeAIDBClusters | View custom clusters. |
| DescribeAIDBClusterTaskAttribute | Query task details | Retrieves the details of a task instance. |
| CreateAIDBClusterDataset | CreateAIDBClusterDataset | Creates a dataset. |
| DescribeAIDBClusterDatasets | DescribeAIDBClusterDatasets | Query datasets |
| ModifyAIDBClusterDescription | ModifyAIDBClusterDescription | Modify the name of an AI instance |
| DescribeAIDBClusterAttribute | Query detailed properties of an AI cluster | Queries the details of a custom instance. |
| DeleteAINodes | DeleteAINodes | Deletes child nodes of an AI instance. |
| CreateAINodes | CreateAINodes | Creates AI nodes. |
| DescribeAIDBClusterTaskLogFiles | DescribeAIDBClusterTaskLogFiles | Queries the logs of model operators. |
| DescribeAIDBClusterTaskMetrics | DescribeAIDBClusterTaskMetrics | Queries the metrics of model operators. |
| DeleteAIDBCluster | DeleteAIDBCluster | Deletes an AI cluster instance. |
| DeleteAIDBClusterDataset | DeleteAIDBClusterDataset | Deletes a dataset. |
| DeleteAIDBClusterTask | DeleteAIDBClusterTask | Deletes a task instance. |
Service-linked roles
|
API |
Title |
Description |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Ccreates a service-linked role. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role has been created. |
| AddEncryptionDBRolePrivilege | AddEncryptionDBRolePrivilege | Grants permissions to a role. |
| ModifyEncryptionDBRolePrivilege | ModifyEncryptionDBRolePrivilege | Modifies role permissions. |
| DeleteEncryptionDBRolePrivilege | DeleteEncryptionDBRolePrivilege | Deletes a role. |
| DescribeEncryptionDBRolePrivilege | DescribeEncryptionDBRolePrivilege | Queries a list of permissions for a database role. |
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 |
| 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 a license order. |
| DescribeLicenseOrders | DescribeLicenseOrders | This operation queries a list of license orders. |
| CreateActivationCode | CreateActivationCode | Generates activation codes for the lightweight version. |
| DescribeActivationCodeDetails | DescribeActivationCodeDetails | Queries an activation code. |
| DescribeCrossCloudLevels | DescribeCrossCloudLevels | Queries the supported cross-cloud specifications. |
| DescribeCrossCloudRegion | DescribeCrossCloudRegion | Queries cross-cloud regions. |
| DescribeCrossCloudRegionMappingToAliyun | DescribeCrossCloudRegionMappingToAliyun | This operation queries cross-cloud region mappings. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries task statistics in Task Center. |
| DescribeResourcePackages | DescribeResourcePackages | Describes cross-cloud resource plans. |
| DescribeUpgradeReport | DescribeUpgradeReport | Queries the verification reports. |
| ExecuteCrossCloudOpenAPI | ExecuteCrossCloudOpenAPI | Calls a cross-cloud OpenAPI. |
| GenerateUpgradeReportForSyncClone | GenerateUpgradeReportForSyncClone | Generates a report for a pre-upgrade check. |
| ListOrders | ListOrders | Queries a list of orders. |
| ModifyResourcePackage | ModifyResourcePackage | Modifies a cross-cloud resource plan. |
| DescribePolarAgentChatRecords | DescribePolarAgentChatRecords | Queries the chat records of a specified session. |
| DescribePolarAgentSessionStatus | DescribePolarAgentSessionStatus | Queries the status of a session. |
| DescribePolarAgentUserSessions | DescribePolarAgentUserSessions | Queries historical session records. |
| GetPolarAgent | GetPolarAgent | Creates a chat record. |
| ApprovePolarClawDevicePair | ApprovePolarClawDevicePair | Approves a PolarClaw device pairing. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| CreateAIDBCluster | CreateAIDBCluster | This topic describes how to create an AI cluster. |
| CreateBatchConsumer | Create gateway user API keys in batches | Creates API keys in batches. |
| CreateBatchTask | CreateBatchTask | Creates a batch task. |
| CreateDatabase | CreateDatabase | Creates a database for a PolarDB cluster. |
| CreateOrGetVirtualLicenseOrder | CreateOrGetVirtualLicenseOrder | Creates or obtains a virtual license order. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a PolarDB cluster. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DescribeAgenticDBClusters | Query agentic cluster list | Queries the list of Agentic Database clusters. |
| DescribeApikeyAttribute | Query API key details | Queries the details of a specified API key. |
| DescribeApplicationPerformance | DescribeApplicationPerformance | Querying PolarDB AI application performance. |
| DescribeApplicationSessionIds | Query AI application sessions | Queries AI application sessions. |
| DescribeBatchTask | DescribeBatchTask | Queries the status of a batch task. |
| DescribeBatchTasks | DescribeBatchTasks | Queries the status of batch tasks. |
| DescribeDBClusterMonitor | DescribeDBClusterMonitor | Queries the interval at which the monitoring data of a PolarDB cluster is collected. |
| DescribeDBClusterPrice | Query DB instance price | Queries the price of a cluster. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for Oracle cluster. |
| 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. |
| DescribeGatewayApikeyList | Query all API keys under a UID | Queries all API keys under the current UID. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| DescribePolarClawAgentFile | Query polarClaw agent file | Queries a PolarClaw Agent file. |
| DescribePolarClawAgentTools | Query polarClaw agent tool catalog | Queries the PolarClaw Agent tool catalog. |
| DescribePolarClawSkillDetail | Query polarClaw skill details | Queries the details of a PolarClaw Skill. |
| DescribePolarClawTask | DescribePolarClawTask | Queries the status of a PolarClaw asynchronous task. |
| DescribePolarFs | Query polarFS cluster list | Queries PolarFS information. |
| DescribePolarFsQuotaList | DescribePolarFsQuotaList | Retrieves the quota list. |
| DescribeRegions | DescribeRegions | Queries the regions and zones that are supported by PolarDB. |
| DescribeSharedBackups | DescribeSharedBackups | Queries shared backup sets. |
| DescribeTasks | DescribeTasks | Queries the progress details of tasks generated by API calls, such as creating a cluster. |
| FailoverDBCluster | FailoverDBCluster | Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster. |
| InstallPolarClawSkill | Install polarClaw skill | Installs a PolarClaw Skill. |
| ListPolarClawDevicePairs | ListPolarClawDevicePairs | List PolarClaw device pairings |
| 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. |
| LoginPolarClawChannel | LoginPolarClawChannel | Logs into a PolarClaw channel. |
| 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. |
| ModifyDBClusterMonitor | ModifyDBClusterMonitor | Modifies the interval at which the monitoring data of a PolarDB cluster is collected. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
| OperateApplication | Manage a polarDB AI application | Restarts, pauses, or starts an application on a PolarDB instance without deleting the instance. |
| ReactivateDBClusterBackup | ReactivateDBClusterBackup | Reactivates the backup feature. |
| RejectPolarClawDevicePair | RejectPolarClawDevicePair | Rejects a PolarClaw device pairing request. |
| RemovePolarClawDevicePair | RemovePolarClawDevicePair | Unpairs a PolarClaw device. |
| RestartDBLink | RestartDBLink | Restarts database links. |
| SearchMemories | SearchMemories | Retrieves memories based on a search query. |
| SearchPolarClawSkills | Search polarClaw skills | Searches for PolarClaw Skills. |
| SwitchOverGlobalDatabaseNetwork | SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a global database network (GDN). |
| TagResources | TagResources | Adds tags to PolarDB clusters. |
| UntagResources | UntagResources | Detaches tags from a PolarDB cluster. |
| UpdatePolarClawAgentSkills | Update polarClaw agent skills | Updates the skills of a PolarClaw Agent. |
| UpdatePolarClawAgentTools | Update polarClaw agent tool configuration | Updates the tool configuration of a PolarClaw Agent. |
| UpdatePolarClawSkill | Update polarClaw skill configuration | Updates the PolarClaw Skill configuration. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |