API overview
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 | Create a storage plan | 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 | Evaluate resources | Evaluates resource availability. |
| ModifyAutoRenewAttribute | Set the auto-renewal status for a subscription cluster | Sets the auto-renewal status for a subscription PolarDB cluster. |
| TransformDBClusterPayType | Change the billing method of a cluster | Changes the billing method of a PolarDB cluster. |
| DescribeZones | List zones | Queries zones. |
| DescribeVSwitchList | List vSwitches | Queries vSwitch information. |
| 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 | Release a pay-as-you-go polarDB cluster | Releases a pay-as-you-go PolarDB cluster. |
| DescribeDBClusters | Query the cluster list | Queries a list of PolarDB clusters or the details of clusters with RAM authorization. |
| DescribeDBClusterAttribute | View detailed attributes of a polarDB cluster | Queries the attributes 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. |
| DescribeRegions | DescribeRegions | Queries the regions and zones that are supported by PolarDB. |
| 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 | Modify a serverless scheduled task | Modifies a scheduled task policy. |
| 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 | Modify storage performance | 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. |
| DescribeDasConfig | DescribeDasConfig | Queries the configurations of a cluster in Database Autonomy Service (DAS). |
| ModifyDBClusterVpc | Change the VPC of database endpoints | Modifies the vSwitch parameters of a cluster. |
| EnableDBClusterDynamoDB | Enable dynamoDB compatibility for a cluster | Enables DynamoDB compatibility. |
| DisableDBClusterDynamoDB | Disable dynamoDB compatibility for a cluster | Disables the DynamoDB compatibility feature. |
| EnableDBClusterOrca | Enable orca for a cluster | Enables the relational feature for a cluster. |
| DisableDBClusterOrca | Disable orca for a cluster | Disables Orca for a cluster. |
High-availability deployment architecture
|
API |
Title |
Description |
| ModifyDBClusterPrimaryZone | ModifyDBClusterPrimaryZone | Changes the primary zone of a PolarDB cluster. |
| FailoverDBCluster | Perform a manual primary/secondary switchover for a cluster | Performs a manual primary/secondary switchover for a PolarDB cluster. You can specify a read-only node as the new primary node. |
| ModifyDBClusterArch | Modify the high-availability mode of a cluster | Modifies the high-availability mode of a cluster. |
| DescribeDBLogFiles | DescribeDBLogFiles | Queries the logs of a PolarDB cluster, such as primary/secondary failover logs. |
| DescribeHALogs | Query instance high-availability logs | Queries high-availability logs of an instance. |
Engine version management
|
API |
Title |
Description |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries the available minor engine versions. |
| DescribeDBClusterVersion | View kernel version information of a PolarDB for MySQL cluster | Queries the details of the current kernel version of a PolarDB for MySQL cluster. |
| UpgradeDBClusterVersion | Upgrade the kernel version of a PolarDB for MySQL cluster | Upgrades the kernel version of 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 a cluster whitelist | Creates or modifies the whitelist of a cluster, including IP address whitelists and security groups. |
Global IP whitelist template management
|
API |
Title |
Description |
| CreateGlobalSecurityIPGroup | Create a global whitelist | Creates a global IP whitelist template. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DescribeGlobalSecurityIPGroup | Query the list of global IP allowlist templates | Queries the list of global IP allowlist templates. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| 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 | Configure SSL encryption for a cluster | Enables or performs a shutdown of 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 | Query TDE settings of a polarDB cluster | Queries the Transparent Data Encryption (TDE) settings of a PolarDB cluster. |
| DescribeUserEncryptionKeyList | Query custom keys of an instance | Queries the list of KMS keys. |
| DescribeEncryptionDBSecret | Query encryption key status | Retrieves encryption information. |
| ModifyEncryptionDBSecret | Modify encryption key | Modifies an encryption policy. |
| ModifyDBClusterTDE | Enable TDE for a polarDB cluster | Enables Transparent Data Encryption (TDE) for a specified PolarDB cluster. You must activate Key Management Service (KMS) before you enable TDE. TDE cannot be disabled after it is enabled. |
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 | Enable or disable SQL throttling rules for an instance | Enables or disables SQL throttling rules. |
| AddSQLRateLimitingRules | Add an SQL throttling rule | Adds an SQL throttling rule. |
| DescribeSQLRateLimitingRules | Query SQL throttling rules | Queries the information about SQL throttling rules. |
| ModifySQLRateLimitingRules | Modify an SQL throttling rule | Modifies an SQL throttling rule. |
| DeleteSQLRateLimitingRules | Delete SQL throttling rules | 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 | Delete a read-only node from a polarDB cluster | Deletes a read-only node 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 | Modify the node specifications of a polarDB cluster | Modifies the node specifications of a PolarDB cluster. |
| ModifyDBNodesClass | Modify the specifications of a single node in a polarDB cluster | Modifies the specifications of a single node in a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | Enable or disable a cluster node | Modifies the hot standby replica mode of a database node in a specified cluster. |
| RestartDBNode | Restart a polarDB cluster node | Restarts a node in a PolarDB cluster. |
| TempModifyDBNode | Temporarily upgrade a cluster or add nodes | Temporarily changes the specifications of a cluster. |
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 | Query parameter modification history | Queries the modification history of query parameters. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a PolarDB parameter template. |
| ModifyDBClusterAndNodesParameters | Modify cluster parameters and apply them to specified nodes | Modifies the parameters of a cluster and applies them to specified nodes. |
| ModifyDBClusterParameters | Modify polarDB cluster parameters | Modifies the parameters of a PolarDB cluster or applies an existing parameter template to the specified cluster. |
| ModifyDBNodesParameters | Modify parameters of a single node and apply them to the specified node | Modifies the parameters of a single node and applies them to the specified node. |
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 PolarDB. |
| 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 | Modify cluster endpoint attributes of a polarDB cluster | Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling. |
| ModifyDBEndpointAddress | Modify cluster endpoint | Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name. |
| DeleteDBClusterEndpoint | Release a polarDB custom cluster endpoint | Releases a custom cluster endpoint of a PolarDB cluster. |
| DeleteDBEndpointAddress | Release the public endpoint of a cluster | Releases the public endpoint of a PolarDB cluster, including the public network connection addresses of the primary endpoint, the default cluster endpoint, and custom cluster endpoints. |
Log management
|
API |
Title |
Description |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of slow query logs for a PolarDB cluster. |
| DescribeSlowLogs | Query slow query log statistics information of a PolarDB cluster | Queries the slow query log statistics information of 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. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| DescribeAccounts | Query database account information | Queries the database account information 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 | Modify the lock status of a polarDB database account | Modifies 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. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a database account for a specified PolarDB cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for a PolarDB database account. |
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 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 | Delete a global database network | Deletes a global database network (GDN). |
| DescribeGlobalDatabaseNetwork | Query global database network details | Queries the details of 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). |
| SwitchOverGlobalDatabaseNetwork | Switch primary and secondary clusters in a global database network | Switches the primary and secondary clusters in 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 sets | Queries the backup information of a PolarDB cluster. |
| DescribeBackupTasks | DescribeBackupTasks | Retrieves a list of backup jobs and their details for a cluster. |
| DescribeBackupLogs | Query backup logs | Queries the list of backup logs and retrieves their download URLs. |
| DescribeDetachedBackups | Query backup set details in a released cluster | Queries the details of backup sets in a released PolarDB cluster. |
| DescribeDBClustersWithBackups | DescribeDBClustersWithBackups | Queries PolarDB clusters in a region that have backup sets. |
| DescribeBackupRegions | List backup set regions | Queries the region information of backup sets. |
| DescribeAvailableCrossRegions | DescribeAvailableCrossRegions | Retrieves a list of regions available for cross-region backup. |
| DescribeLocalAvailableRecoveryTime | Query the restorable time range of backups | Queries the restorable time range of backups. |
| DescribeBackupLogDownloadLinks | Query redo log backup download links | Queries the download links of redo log backups. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| ReactivateDBClusterBackup | Re-enable the backup feature for a polarDB instance | Re-enables the backup feature. |
| Backup policies | Backup policies | |
| DescribeBackupPolicy | View the automatic backup policy of a polarDB cluster | 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 | Modify backup policy settings | Modifies the automatic backup policy of a PolarDB cluster. |
| ModifyLogBackupPolicy | Modify the log backup retention policy of a cluster | Modifies the log backup retention policy of a PolarDB cluster. |
Database and table restoration
|
API |
Title |
Description |
| DescribeMetaList | DescribeMetaList | Queries recoverable databases and tables. |
| RestoreTable | Restore specific databases or tables of a polarDB instance to the original instance | Restores the databases and tables of a PolarDB cluster. |
Migration from RDS
|
API |
Title |
Description |
| DescribeDBClusterMigration | DescribeDBClusterMigration | Queries the migration status of a PolarDB cluster. |
| ModifyDBClusterMigration | Switch or roll back a migration task | Switches or rolls back a migration task for the one-click upgrade from ApsaraDB 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 | Query resource tags in a specified region | Queries the resource tags in a region. |
| UntagResources | Remove tags from a cluster | Removes tags from one or more PolarDB clusters. |
| TagResources | Tag an instance | Adds tags to an instance. |
| ListTagResources | Query the tags bound to one or more polarDB clusters | Queries the tags bound to one or more PolarDB clusters, or the PolarDB clusters bound to one or more tags. |
Pending event management
|
API |
Title |
Description |
| DescribeHistoryEvents | Query events in the event center | Queries the events in the event center. |
| ModifyActiveOperationMaintainConf | Modify proactive O&M events | Configures the O&M information for a user, which currently includes the proactive O&M window information. |
| DescribeActiveOperationMaintainConf | View proactive O&M events | Retrieves the O&M configuration information for a user, including proactive O&M window information. |
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Retrieves a count of pending events for various task types. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
| ModifyActiveOperationTasks | Modify the planned switchover time of an O&M event | Modifies the switchover time of a scheduled O&M event for an instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries operation and maintenance events for instances. |
| CancelActiveOperationTasks | Cancel O&M events | Cancels multiple O&M events. |
Scheduled task management
|
API |
Title |
Description |
| DescribeHistoryTasks | Query historical tasks | Queries the historical task list for PolarDB for MySQL. |
| DescribeTasks | Retrieve task list | Queries the progress details of tasks generated through API operations, such as creating a cluster. |
| 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 |
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| 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 | Query the performance data of a polarDB cluster | 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. |
| 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. |
| DescribeAIDBClusterPerformance | Retrieve AI container performance metrics | Retrieves AI container performance metrics. |
PolarDB for AI
|
API |
Title |
Description |
| DescribeAITaskStatus | DescribeAITaskStatus | Retrieves the status of the PolarDB for AI feature. |
| OpenAITask | Enable AI tasks | Enables the PolarDB for AI feature. |
| CloseAITask | Disable AI task | Disables the PolarDB for AI feature. |
Network channel
|
API |
Title |
Description |
| CreateNetworkChannel | Create a network channel | Creates a network channel. |
| DescribeNetworkChannel | Query a network channel | Queries a network channel. |
| DeleteNetworkChannel | DeleteNetworkChannel | Deletes a network channel. |
DBLink
|
API |
Title |
Description |
| CreateDBLink | CreateDBLink | Creates a DBLink. |
| RestartDBLink | RestartDBLink | Restarts database links. |
| DeleteDBLink | Delete a database link from a cluster | Deletes a database link from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
| DescribeDBLinks | Query cluster dBLink information | Queries the DBLink information of 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. |
Plug-ins
|
API |
Title |
Description |
| CreateExtensions | Install an extension | Creates an extension. |
| DescribeExtensions | Query installed plugins | Queries plugin details. |
| UpdateExtensions | UpdateExtensions | Updates one or more extensions. |
| DeleteExtensions | DeleteExtensions | Deletes an extension. |
Cold data archiving
|
API |
Title |
Description |
| CreateColdStorageInstance | Create a cold storage instance | Creates a cold storage instance. |
| DescribeColdStorageInstance | Describe cold storage instances | Queries cold storage instance information. |
PolarDB applications
|
API |
Title |
Description |
| DescribeApplications | List polarDB applications | Retrieves a list of applications for all PolarDB instances in a specified region. |
| CreateApplication | Create a polarDB application | Creates an application attached to a PolarDB instance. |
| DescribeApplicationAttribute | Query polarDB application properties | Retrieves the details of the specified PolarDB instance application. |
| 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 | Modify the serverless configuration of a polarDB application | 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 | Apply a prompt policy | Applies a prompt policy to an instance. |
| CreateApplicationPrompt | Create application prompt | Creates an application prompt policy. |
| DescribeApplicationPrompts | Query application prompts | Queries all application prompt policies for the current application. |
| ModifyApplicationPrompt | Modify application prompt | Modifies the prompt policy of an application. |
| DeleteApplicationPrompt | Delete application prompt | Deletes the prompt policy for an application. |
| SearchMemories | Search application memories | Retrieves memories. |
| AttachApplicationPolarFS | Mount a polarlakebase instance to a polarDB application | Mounts a specified Polarlakebase instance to a PolarDB application. |
| DeleteApplication | Delete a polarDB application | Deletes a specified PolarDB application without deleting the PolarDB instance itself. |
| 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 details of AI application logs. |
| PolarClaw | PolarClaw | |
| GetPolarClawConfig | Retrieve polarClaw configuration | Retrieves the PolarClaw configuration. |
| PatchPolarClawConfig | Update polarClaw configuration | Updates the PolarClaw configuration. |
| DescribePolarClawAgents | List polarClaw agents | Queries all installed plugins and their status information for a specified application. |
| CreatePolarClawAgent | Create a polarClaw agent | Creates a new PolarClaw agent. |
| UpdatePolarClawAgent | Update a polarClaw agent | Updates a PolarClaw agent. |
| UpgradePolarClawSkills | UpgradePolarClawSkills | Upgrades the PolarClaw feature. |
| DeletePolarClawAgent | Delete a polarClaw agent | Removes an agent and its associated bindings from a specified PolarClaw. |
| ListPolarClawBindings | List all polarClaw bindings | Lists PolarClaw bindings. |
| UnbindPolarClawAgent | Disassociate a polarClaw agent | Disassociates a PolarClaw agent. |
| BindPolarClawAgent | Associate a polarClaw agent | Associates a specified channel with a specific PolarClaw agent. |
| DescribePolarClawPlugins | List all polarClaw plugins | Lists all installed PolarClaw plugins and their status information. |
| InstallPolarClawPlugin | Install the polarClaw plugin | Installs the PolarClaw plugin. |
| EnablePolarClawPlugin | EnablePolarClawPlugin | Enables a PolarClaw plugin. |
| DisablePolarClawPlugin | Disable the polarClaw plug-in | Disables the PolarClaw plug-in. |
| UpgradePolarClawPlugin | Upgrade a polarClaw plug-in | Upgrades a plug-in in a PolarClaw application. |
| UninstallPolarClawPlugin | Uninstall the polarClaw plugin | Uninstalls the PolarClaw plugin. |
| DescribePolarClawChannels | List polarClaw channels | Lists all installed PolarClaw channels and their status information. |
| CreatePolarClawChannel | Create a polarClaw channel | Creates a new communication 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 | List all polarClaw scheduled jobs | Queries all or specified scheduled jobs and their details in PolarClaw. |
| CreatePolarClawCronJob | Create a scheduled task | 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 | Execute a polarClaw scheduled task | Executes a PolarClaw scheduled task. |
| DeletePolarClawCronJob | DeletePolarClawCronJob | Deletes a PolarClaw cron job. |
| DescribePolarClawMCPServers | List all polarClaw MCP services | Lists all installed PolarClaw MCP services and configurations. |
| AddPolarClawMCPServer | Add a polarClaw MCP server | Adds an MCP server to a specified PolarClaw application. |
| RemovePolarClawMCPServer | Delete a polarClaw MCP service | Deletes a PolarClaw MCP service. |
AI gateway
|
API |
Title |
Description |
| CreateGateway | CreateGateway | Creates a gateway instance. |
| DescribeGatewayList | Query gateway instances | Queries a list of gateway instances. |
| DescribeGatewayAttribute | Query gateway instance details | Queries the details of a gateway instance. |
| DeleteGateway | Delete a gateway instance | Deletes a gateway instance. |
| CreateBudgetPolicy | Create a budget policy | Creates a budget policy. |
| DescribeBudgetPolicies | Query budget policies | Queries budget policies. |
| ModifyBudgetPolicy | Modify a budget policy | Modifies a budget policy. |
| DeleteBudgetPolicy | Delete a budget policy | Deletes a budget policy. |
| CreateRateLimitPolicy | Create a throttling policy | Creates a throttling policy. |
| DescribeRateLimitPolicy | Query throttling policies | Queries throttling policies. |
| ModifyRateLimitPolicy | Modify a throttling policy | Modifies a throttling policy. |
| DeleteRateLimitPolicy | Delete a throttling policy | Deletes a throttling policy. |
| CreateModelService | Create a model creation service | Creates a model creation service. |
| DescribeModelServices | List model services | Queries the list of model services. |
| ModifyModelService | Modify a model service | Modifies a model service. |
| DeleteModelService | Delete a model service | Deletes a model service. |
| CreateModelApi | Create model API | Creates a routing rule. |
| DescribeModelApis | Query model aPIs | Queries model APIs. |
| ModifyModelApi | Modify a model API | Modifies a model API. |
| DeleteModelApi | Delete a model API | Deletes a model API. |
| CreateCostRule | Create a cost rule | Creates a cost rule. |
| DescribeCostRules | Query cost rules | Queries cost rules. |
| ModifyCostRule | Modify a cost rule | Modifies a cost rule. |
| DeleteCostRule | Delete a cost rule | Deletes a cost rule. |
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group. |
| DescribeConsumerGroups | Query consumer groups | Queries consumer groups. |
| ModifyConsumerGroup | Modify a consumer group | Modifies a consumer group. |
| DeleteConsumerGroup | Delete a consumer group | Deletes a consumer group. |
| CreateConsumer | Create a consumer | Creates a consumer. |
| DescribeConsumers | List consumers | Queries the list of consumers. |
| ModifyConsumer | ModifyConsumer | Modifies the properties of a consumer. |
| DeleteConsumer | Delete a consumer | Deletes a consumer. |
| ResetConsumerApiKey | Reset an API key | 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 | Query polarlakebase quota rules | Queries all quota rules for a specified Polarlakebase instance. |
| SetPolarFsFileQuota | Apply quota rules to directories | Sets file quota rules for specified directories in a Polarlakebase instance. |
| CheckPolarFsQuotaConsistency | Check quota consistency | Checks the consistency status 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 | Query polarlakebase global database network (GDN) details across all regions | Queries the details of Polarlakebase Global Database Networks (GDNs) across all regions. |
| CreateGlobalDataNetwork | Create a polarlakebase global database network | Creates a Polarlakebase global database 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 in a specified path. |
| CreatePolarFsObject | Create a directory | Creates a new directory in a specified PolarFS instance. |
| MovePolarFsObjects | MovePolarFsObjects | Renames or moves files in a PolarFs instance. |
| DeletePolarFsObjects | Delete files | Deletes PolarLakebase files. Currently, only the Basic Edition and Cold Storage Edition are supported. |
| AddPolarFsPathMapping | Add bucket path mapping for polarFS transparent acceleration | Adds a transparent acceleration path. |
| DeletePolarFsPathMapping | Delete bucket path mappings configured for polarFS transparent acceleration | Deletes the transparent acceleration path mapping. |
AI cluster
|
API |
Title |
Description |
| DescribeAvailableModels | Retrieve AI cluster models | Retrieves a list of models in an AI cluster. |
| CreateAIDBClusterTask | Create a model creation operator instance | Creates a model creation operator instance. |
| DescribeAIDBClusterTasks | List model operators | Retrieves a list of model operators for a specified PolarDB instance. |
| DescribeAIDBClusters | List AI clusters | Queries the list of custom clusters. |
| DescribeAIDBClusterTaskAttribute | Retrieve task details | Retrieves the details of a task instance. |
| CreateAIDBClusterDataset | Create a dataset | Creates a dataset. |
| DescribeAIDBClusterDatasets | Query dataset list | Queries a list of datasets. |
| ModifyAIDBClusterDescription | ModifyAIDBClusterDescription | Modify the name of an AI instance |
| DescribeAIDBClusterAttribute | Query detailed attributes of an AI cluster | Queries the details of a custom instance. |
| DeleteAINodes | DeleteAINodes | Deletes child nodes of an AI instance. |
| CreateAINodes | Add a child node to an AI cluster | Creates an AI node. |
| DescribeAIDBClusterTaskLogFiles | Query model operator logs | Queries model operator logs. |
| DescribeAIDBClusterTaskMetrics | Query model operator metrics | Queries model operator metrics. |
| DeleteAIDBCluster | Delete an AI cluster instance | Deletes an AI cluster instance. |
| DeleteAIDBClusterDataset | DeleteAIDBClusterDataset | Deletes a dataset. |
| DeleteAIDBClusterTask | Delete a task | Deletes a task instance. |
Knowledge space management
|
API |
Title |
Description |
| CreateKnowledgeSpace | Create a knowledge space | Creates a knowledge space. |
| DescribeKnowledgeSpaceAttribute | View knowledge space details | Queries the details of a knowledge space. |
| UpdateKnowledgeSpace | Update a knowledge space | Updates a knowledge space. |
| CreateKnowledgeBase | Create a knowledge base | Creates a knowledge base. |
| DescribeKnowledgeBaseAttribute | Query knowledge base details | Queries the details of a knowledge base. |
| DescribeKnowledgeBases | Query knowledge base list | Queries a list of knowledge bases. |
| UpdateKnowledgeBase | Update a knowledge base | Updates a knowledge base. |
| UpdateKnowledgeBaseFileShardingStrategy | Update knowledge base file chunking strategy | Updates the chunking strategy for a file in a knowledge base. |
| TriggerKnowledgeBaseSync | Trigger knowledge base synchronization | Triggers knowledge base synchronization. |
| RetrievalKnowledgeBase | Search a knowledge base | Searches a knowledge base. |
| AnswerKnowledgeBase | Perform single-turn Q&A based on a knowledge base | Answers a single-turn question based on a knowledge base. |
| DescribeKnowledgeBaseAnswer | Query single-turn Q&A results of a knowledge base | Queries the single-turn Q&A results of a knowledge base. |
| DeleteKnowledgeBase | Delete a knowledge base | Deletes a knowledge base. |
| CreateKBSyncLink | Create a knowledge base synchronization link | Creates a knowledge base synchronization link. |
| DescribeKBSyncLinks | List knowledge base synchronization links | Queries the synchronization links of a knowledge base. |
| UpdateKBSyncLink | Update knowledge base synchronization link | Updates the synchronization link for a knowledge base. |
| DeleteKBSyncLink | Delete a knowledge base synchronization link | Deletes a knowledge base synchronization link. |
| DescribeKnowledgeBaseFiles | Query knowledge base file list | Queries the list of files in a knowledge base. |
| DeleteKnowledgeBaseFile | Delete a knowledge base file | Deletes a knowledge base file. |
| RetryKnowledgeBaseFiles | Batch retry failed files in a knowledge base | Retries failed files in a knowledge base in batches. |
| RegisterKnowledgeBaseFile | Register an OSS file to a knowledge base | Registers an OSS file to a knowledge base. |
| DescribeKnowledgeBaseFileShards | Query file shards in a knowledge base | Queries the list of file shards in a knowledge base. |
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 | Upgrade the kernel version of an edge cluster | Upgrades the minor engine version of a PolarDB on ENS cluster. |
| CreateAccountZonal | Create an edge cluster account | Creates an account for an edge cluster. |
| RestartDBNodeZonal | RestartDBNodeZonal | Restarts a node of an edge cluster for PolarDB on ENS. |
| DescribeAccountsZonal | Query edge cluster account information | Queries the list of PolarDB edge clusters. |
| DeleteDBClusterEndpointZonal | Delete a custom cluster endpoint for an edge cluster | Deletes the endpoint of a PolarDB on ENS cluster. |
| CreateDatabaseZonal | Create a database for an edge cluster | Creates a database for an ApsaraDB for PolarDB edge cluster. |
| GrantAccountPrivilegeZonal | Grant database access to a standard account in an edge cluster | Modifies the privileges of an account in a PolarDB on ENS cluster. |
| ModifyDBDescriptionZonal | Modify database description in an edge cluster | Modifies the description of a database in a PolarDB on ENS cluster. |
| CheckDBNameZonal | Validate the database name for an edge cluster | Checks the database name for ApsaraDB PolarDB on ENS. |
| DescribeDBClusterVersionZonal | Query kernel version information of an edge cluster | Queries the version of a PolarDB on ENS cluster. |
| ModifyDBClusterEndpointZonal | Modify cluster endpoint attributes for an edge cluster | Modifies the endpoint of PolarDB on ENS. |
| ModifyAccountPasswordZonal | Modify the password of an account for an edge cluster | Modifies the password of an account for PolarDB on ENS. |
| DeleteAccountZonal | Delete an account for a polarDB on ENS cluster | Deletes an account for a PolarDB on ENS cluster. |
| ModifyAccountDescriptionZonal | Modify the description of an edge cluster account | Modifies the description of a PolarDB on ENS account. |
| ResetAccountZonal | ResetAccountZonal | Resets an account in a PolarDB for Xscale cluster. |
| CreateDBClusterEndpointZonal | Create a custom cluster endpoint for an edge cluster | Creates a custom cluster endpoint for an edge cluster. |
| RevokeAccountPrivilegeZonal | Revoke database access permissions for an edge cluster account | Revokes account permissions. |
| ModifyDBClusterDescriptionZonal | Modify the name of an edge cluster | Modifies the description of a cluster. |
| DescribeDatabasesZonal | Query edge cluster database information | Queries ApsaraDB PolarDB on ENS databases. |
| DescribeDBClusterEndpointsZonal | Query endpoint information of an edge cluster | Queries the endpoints of PolarDB on ENS. |
| DeleteDatabaseZonal | Delete a database in an edge cluster | Deletes a database in a PolarDB on ENS cluster. |
| FailoverDBClusterZonal | Perform a manual primary/secondary switchover for an edge cluster | Performs a manual primary/secondary switchover for an edge cluster. |
| DescribeDbClusterAttributeZonal | Query edge cluster details | Queries the details of an edge cluster. |
| CheckAccountNameZonal | Validate the edge cluster account name | Checks the PolarDB account name. |
| DescribeDBClustersZonal | DescribeDBClustersZonal | Lists the PolarDB clusters in MyBase. |
Others
|
API |
Title |
Description |
| DescribeActivationCodes | Get activation codes | Queries a list of activation codes. |
| DescribeLicenseOrderDetails | Retrieve license order details | Retrieves the details of a license order. |
| DescribeLicenseOrders | Query license order list | Queries the list of license orders. |
| CreateOrGetVirtualLicenseOrder | Create or retrieve a virtual certificate order | Creates or retrieves a virtual certificate order. |
| CreateActivationCode | Generate an activation code for the lightweight edition | Generates an activation code for the lightweight edition. |
| DescribeActivationCodeDetails | Retrieve activation code details | Queries the details of an activation code. |
| DescribeCrossCloudLevels | Query cross-cloud supported specifications | Queries the list of specifications supported for cross-cloud. |
| 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 | Query upgrade/migration verification report | Queries an upgrade or migration verification report. |
| ExecuteCrossCloudOpenAPI | ExecuteCrossCloudOpenAPI | Calls a cross-cloud OpenAPI. |
| GenerateUpgradeReportForSyncClone | Generate an upgrade or migration check report | Generates a check report. |
| ListOrders | Query order list | Queries orders. |
| ModifyResourcePackage | ModifyResourcePackage | Modifies a cross-cloud resource plan. |
| DescribePolarAgentChatRecords | Query the details of a specified session | Queries the details of a specified session. |
| DescribePolarAgentSessionStatus | Query session status | Queries the session status. |
| DescribePolarAgentUserSessions | DescribePolarAgentUserSessions | Queries historical session records. |
| GetPolarAgent | Create a chat record | Creates a chat record. |
| CreateAIDBCluster | Create an AI cluster | Creates an AI cluster. |
| DescribePolarFs | List polarFS clusters | Queries PolarFS information. |
| DescribeSharedBackups | Query shared backup sets | Queries the list of shared backup sets. |
| DescribeApplicationPerformance | Query polarDB AI application performance | Queries the performance of PolarDB AI applications. |
| OperateApplication | Manage a polarDB AI application | Restarts, pauses, or starts an application on a PolarDB instance without deleting the instance. |
| CreateBatchTask | Create a batch task | Creates a batch task. |
| DescribeBatchTask | Query batch task status details | Queries the status details of a batch task. |
| DescribeBatchTasks | Query batch task status | Queries the status of batch tasks. |
| DescribePolarFsQuotaList | Query all quotas | Queries the list of quotas. |
| LoginPolarClawChannel | Log on to the polarClaw channel | Logs on to the PolarClaw channel. |
| RemovePolarClawDevicePair | Remove a paired polarClaw device | Removes a paired PolarClaw device. |
| RejectPolarClawDevicePair | RejectPolarClawDevicePair | Rejects a PolarClaw device pairing request. |
| DescribePolarClawTask | Query the status of a polarClaw asynchronous task | Queries the status of a PolarClaw asynchronous task. |
| ApprovePolarClawDevicePair | Approve polarClaw device pairing | Approves PolarClaw device pairing. |
| ListPolarClawDevicePairs | List polarClaw device pairings | Lists PolarClaw device pairings. |
| DescribeGatewayApikeyList | Query all API keys for the specified UID | Queries all API keys for the specified UID. |
| CreateBatchConsumer | Create gateway user API keys in batches | Creates API keys in batches. |
| DescribeApikeyAttribute | Query the details of the API key | Queries the details of the API key. |
| DescribeDBClusterPrice | Query database instance pricing | Queries the pricing of a cluster. |
| SearchPolarClawSkills | Search polarClaw skills | Searches for PolarClaw skills. |
| InstallPolarClawSkill | Install a PolarClaw skill | Installs a PolarClaw skill. |
| DescribePolarClawAgentFile | Query polarClaw agent files | Queries PolarClaw agent files. |
| UpdatePolarClawAgentTools | Update polarClaw agent tool configuration | Updates the tool configuration of a PolarClaw Agent. |
| UpdatePolarClawAgentSkills | Update the skills of a polarClaw agent | Updates the skills of a PolarClaw agent. |
| UpdatePolarClawSkill | Update polarClaw skill configuration | Updates the PolarClaw skill configuration. |
| DescribePolarClawAgentTools | Query polarClaw agent tool catalog | Queries the PolarClaw Agent tool catalog. |
| DescribePolarClawSkillDetail | Query polarClaw skill details | Queries the details of a PolarClaw skill. |
| DescribeAgenticDBClusters | Query agentic cluster list | Queries the list of Agentic Database clusters. |
| DeleteAgenticDBComputeCluster | Delete an agenticDB compute cluster | Deletes an AgenticDB compute cluster. |
| DescribeAgenticDBProject | Query agenticDB project details | Queries the details of an AgenticDB project. |
| CreateAgenticDBBranch | Create an agenticDB branch | Creates an AgenticDB branch. |
| DescribeAgenticDBTenantApiKeys | List agenticDB tenant API keys | Queries the API keys of AgenticDB tenants. |
| DescribeAgenticDBProjects | List agenticDB projects | Queries the list of AgenticDB projects. |
| DeleteAgenticDBBranch | Delete an agenticDB branch | Deletes an AgenticDB branch. |
| DeleteAgenticDBProject | Delete an agenticDB project | Deletes an AgenticDB project. |
| DescribeAgenticDBComputeClusters | List agenticDB compute instances | Queries a list of AgenticDB compute instances. |
| DescribeAgenticDBBranchLineage | Query agenticDB branch lineage | Queries the branch lineage of an AgenticDB cluster. |
| DescribeAgenticDBBranches | List agenticDB branches | Queries the list of AgenticDB branches. |
| DescribeAgenticDBBranch | Query agenticDB branch details | Queries the details of an AgenticDB branch. |
| DescribeAgenticDBBranchEndpoints | Query agenticDB branch connection information | Queries the connection information of an AgenticDB branch. |
| DeleteAgenticDBTenantApiKey | Delete an agenticDB tenant API key | Deletes an API key of an AgenticDB tenant. |
| VerifyAgenticDBTenantApiKey | Validate agenticDB tenant API key | Validates an AgenticDB tenant API key. |
| ResetAgenticDBTenantApiKey | Reset the API key of an agenticDB tenant | Resets the API key of an AgenticDB tenant. |
| CreateAgenticDBProject | Create an agenticDB project | Creates an AgenticDB project. |
| CreateAgenticDBTenantApiKey | Create an agenticDB tenant API key | Creates an AgenticDB tenant API key. |
| DescribeApplicationSessionIds | Query AI application sessions | Queries AI application sessions. |
| AddPolarOSSAuthorizedAccount | Add authorized accounts for cold storage | Adds authorized accounts for cold storage. |
| BindResourceControl | Bind a resource control rule | Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL cluster. After the binding succeeds, the target object is subject to the CPU quota limit defined by the resource control rule. |
| CheckPolarClawSkill | Validate polarClaw skill | Pre-checks a skill. |
| CreateAIDBClusterApiKey | Create a model creation service API key | Creates an API key for the model creation service. |
| CreateApplicationAgentRelation | Bind an agent to a squad | Binds an Agent to a Squad. |
| CreateApplicationBackup | Create an application backup | Creates a backup for a specified PolarDB application and returns the backup job ID and workflow task ID. |
| CreateDataProcessJob | Create a data processing task | Creates a task to process data in PolarFS based on a specified template and write the data to a PolarDB database. |
| CreateDataProcessJobTemplate | Create a data processing task template | Creates a task template for image data processing in a specified region. |
| CreateGwConsumerOrder | Purchase a token resource plan and activate a redemption code | Places an order to purchase a token resource plan and activates a redemption code. |
| CreateInspectionTask | Create an inspection task | Creates a periodic inspection task for a specified PolarDB cluster. |
| CreateLakebaseS3Account | Create an S3 account | Creates a PolarFS S3 account. |
| CreatePolarClawSkill | Upload polarClaw skill | Uploads a skill. |
| CreatePolarClawSkillTemplate | Create a polarClaw skill template | Creates a PolarClaw skill template. |
| CreatePolarFs | Create a polarFS cluster | Enables PolarFS support. |
| CreateResourceControl | Create a resource control rule | Creates a resource control rule for a specified PolarDB for MySQL cluster. You can set the maximum CPU quota percentage available to the rule by using MaxCpu, or set the maximum number of CPU cores available to the rule by using CpuCount. When you create a rule, you must specify either MaxCpu or CpuCount, but not both. |
| DeleteAIDBClusterApiKey | Delete a model service API key | Deletes an API key for the model service. |
| DeleteDataProcessJobTemplate | Delete a data processing task template | Deletes a data processing task template in a specified region. |
| DeleteLakebaseS3Account | Delete an S3 account | Deletes a PolarFS S3 account. |
| DeletePolarClawSkill | Delete a polarClaw skill | Deletes a PolarClaw skill. |
| DeletePolarFs | Delete a polarFs cluster | Releases a pay-as-you-go PolarFs instance. |
| DeletePolarOSSAuthorizedAccount | Delete cold storage authorized accounts | Deletes authorized accounts for cold storage. |
| DeleteResourceControl | Delete a resource control rule | Deletes a resource control rule from a specified PolarDB for MySQL cluster. |
| DescribeAIAgentOrder | Query AI assistant orders | Queries the AI assistant order information for the current account, including the order status, version, capacity package, and expiration time. |
| DescribeAIDBClusterApiKeys | Query model service API keys | Queries the API keys for the model service. |
| DescribeAIDBClusterResourceUsage | Query AI database cluster resource usage | Queries the node resource usage and pod resource requests in an AI database cluster. |
| DescribeActiveOperationTask | View pending task details | Queries the details of pending tasks. |
| DescribeApplicationAvailableModels | Query available models for an application | Queries the available models, default models, and memory capability configurations for a specified region and application type. |
| DescribeApplicationAvailableVersion | Retrieve upgradable versions for polarDB applications | Queries the list of versions to which a specified application type can be upgraded. |
| DescribeApplicationBackupPolicy | Query application backup policy | Queries the automatic backup cycle, backup time window, and level-1 backup retention period of a specified application. |
| DescribeApplicationBackups | Query application backups | Queries the backup sets of a specified application by time range and backup status, and returns paginated backup details. |
| DescribeApplicationComponentPerformance | Query application component performance | Queries the performance metrics and sample data of a specified application component within a specified time range. |
| DescribeApplicationSessionLogs | Query application session logs | Queries the session logs of a specified application, supports filtering by agent, session, and role, and returns paginated log records. |
| DescribeApplicationUsage | Query AI application usage | Queries the usage of an AI application. |
| DescribeBudgetUsage | Query gateway instance budget usage | Queries the used quota, statistical window, and associated budget policies of a PolarDB gateway instance by budget dimension. |
| DescribeDBClusterModelEnhancement | Query model enhancement information for a cluster | Queries the model enhancement status and the list of API keys for a specified PolarDB cluster. |
| DescribeDBInstances | List database instances | Queries the list of instances. |
| DescribeDataProcessJobAttribute | Query data processing task details | Queries the status, data source, destination database, and processing configuration of a specified data processing task. |
| DescribeDataProcessJobTemplates | List data processing task templates | Queries data processing task templates by region, template ID, or type, and returns paginated template configurations. |
| DescribeDataProcessJobs | List data processing jobs | Queries the data processing jobs of a specified PolarFS instance. You can filter the jobs by job ID and paginate the results. |
| DescribeEdgeCloudRegion | Query edge cloud regions | Queries the available edge cloud regions for the current account, including their central control regions and standby edge cloud regions. |
| DescribeFileSystems | List polarFS files | Queries the file information under a specified path of a PolarFS instance and uses a pagination token to retrieve subsequent results. |
| DescribeHistoryEventsStat | Query event statistics in the event center | Queries the number of events in the Event Center by event category. |
| DescribeInspectionReportList | Query inspection reports | Queries the reports of a specified inspection task. You can filter the reports by time and return the report details in a paginated format. |
| DescribeInspectionTaskAttribute | Query inspection task details | Queries the execution plan, associated clusters, and validity period of a specified inspection task. |
| DescribeInspectionTaskList | List inspection tasks | Performs a paged query of inspection nodes, their execute plans, and associated clusters by inspection space with paging. |
| DescribeInstanceReportAttribute | Query instance inspection report details | Queries the overall score, status, and inspection results of an instance inspection report by report ID. |
| DescribeKVCacheInstanceAttribute | Query kVCache instance details | Queries the region, status, capacity, network, billing method, and expiration information of a specified KVCache instance. |
| DescribeKVCacheInstances | List kVCache instances | Queries KVCache instances filtered by region, associated cluster, or instance ID, and returns paginated instance details. |
| DescribeLakebaseS3Account | Query S3 account details | Queries the details of a PolarFS S3 account. |
| DescribePolarClawSkillAssessment | View polarClaw skill security assessment details | Retrieves the details of a PolarClaw skill security assessment. |
| DescribePolarClawSkillTemplate | Query polarClaw skill template details | Queries the details of a PolarClaw skill template. |
| DescribePolarClawSkillTemplates | Query polarClaw skill templates | Queries PolarClaw skill templates. You can filter the templates by template ID and time range. The results are returned in pages. |
| DescribePolarClawSkills | Query polarClaw skills | Queries PolarClaw skills. |
| DescribePolarClawSkillsMarket | Query the polarClaw skills marketplace | Queries the PolarClaw skills marketplace. |
| DescribePolarFsMapping | Query polarFS mappings | Queries the PolarFS path mapping list. |
| DescribePolarFsPerformance | Query polarFS performance metrics | Queries the performance metrics and sampling data of a specified PolarFS instance within a specified time range. |
| DescribeReplicationSlots | Query replication slots | Queries the replication slots of a specified PolarDB cluster. You can filter the results by the child node name of a distributed instance. |
| DescribeSQLExplorerPolicy | Retrieve SQL resource manager policies | Checks whether the SQL Explorer feature is enabled for the specified cluster. |
| DescribeSQLExplorerRetention | View the SQL Explorer log retention period for a cluster | Queries the SQL Explorer log retention period for a PolarDB cluster. |
| DescribeStoragePlan | List storage plans | Queries the list of storage plans. |
| DisableDBClusterCTable | Disable the column store table feature for a cluster | Disables the column store table feature for a specified PolarDB cluster. |
| DisableDBClusterDocumentDB | Disable document database support for a cluster | Disables document database support for a specified PolarDB cluster. |
| EnableAIDBClusterDatasetService | Enable the dataset management service | Enables the dataset management service for a cold storage instance. |
| EnableDBClusterCTable | Enable the column store table feature for a cluster | Enables the column store table feature for the specified PolarDB cluster. |
| EnableDBClusterDocumentDB | Enable document database support for a cluster | Enables document database support for an instance. |
| GetLakebaseTenantToken | Retrieve lakebase tenant token | Retrieves the Lakebase tenant token (SPG tenant mount URL). |
| GetPolarClawSkillRegion | Retrieve the central bucket for polarClawSkill | Retrieves the central bucket for polarClawSkill. |
| ListLakebaseS3Accounts | List S3 accounts | Lists PolarFS S3 accounts. |
| ModifyAIDBClusterTask | Modify a task | Modifies a task. |
| ModifyApplicationBackupPolicy | Modify application backup policy | Modifies the automatic backup cycle, backup time window, and level-1 backup retention period of a specified application. |
| ModifyApplicationEndpointAddress | Modify a polarDB application endpoint address | Modifies a PolarDB application endpoint address. |
| ModifyDBClusterAutoUpgradeMinorVersion | Modify the minor engine version update policy for a cluster | Modifies the minor engine version update policy for a specified PolarDB cluster. |
| ModifyDBNodeRouterWeight | Configure database proxy weights | Modifies the routing access weights of nodes. |
| ModifyLakebaseS3AccountPolicy | Modify S3 account policy | Modifies the PolarFS S3 account policy. |
| ModifyPolarClawSkill | Modify a polarClaw skill | Modifies a PolarClaw skill. |
| ModifyPolarFs | Modify polarFs configuration | Modifies the PolarFs configuration. |
| ModifyPolarFsInstanceDescription | Modify the description of a polarFS instance | Modifies the description of a PolarFS instance. |
| ModifyPolarFsMappingAuth | Modify polarFS mapping credentials | Modifies the bucket credentials for the PolarFS path mapping. |
| ModifyResourceControl | Modify a resource control rule | Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU quota percentage mode and the maximum CPU core count mode. When modifying the rule, you must specify either MaxCpu or CpuCount, but not both. |
| ModifySecurityIps | Modify the instance whitelist | Modifies the IP address whitelist of a specified PolarDB cluster. |
| ModifyTaskInfo | Modify task information in task center | Modifies task information in Task Center. |
| RefreshProxyLevel | Modify cluster proxy performance level | Modifies the proxy performance level of a specified PolarDB cluster and supports scheduled execution. |
| RestartAIDBCluster | Restart an AIDB cluster | Restarts an AI cluster. |
| RestartDBCluster | Restart a polarDB cluster | Restarts a specified PolarDB cluster. |
| RestartPolarClawGateway | Restart a polarClaw gateway | Restarts a PolarClaw gateway. |
| RestoreApplicationByBackupSet | Restore an application by using a backup set | Restores a PolarDB application by using a specified backup set. |
| UnbindResourceControl | Unbind a resource control rule | Unbinds a specified resource control rule from a user, database, query, or connection in a PolarDB for MySQL cluster. After the unbinding is successful, the resource control rule no longer limits the CPU quota of the corresponding target object. |
| UninstallPolarClawSkills | Uninstall a polarClaw skill | Uninstalls a PolarClaw skill. |
| UpgradeApplicationVersion | Upgrade AI application minor version | Upgrades an application to a new version. |
| ApplyLakebaseMountParameterGroup | Apply a parameter template to lakebase | Applies a parameter template to Lakebase. |
| CreateLakebaseMountParameterGroup | Create a lakebase mount parameter template | Creates a Lakebase mount parameter template. |
| DeleteLakebaseMountParameterGroup | Delete a parameter template mounted to lakebase | Deletes a parameter template mounted to Lakebase. |
| DescribeApplicationSSL | Query application SSL configuration | Queries the SSL configuration of an application. |
| DescribeLakebaseMountParameterGroup | Query the details of a parameter template mounted to lakebase | Queries the details of a parameter template mounted to Lakebase. |
| DescribeLakebaseMountParameterGroupChangeLogs | Query the change history of parameter templates mounted to lakebase | Queries the change history of parameter templates mounted to Lakebase. |
| DescribeLakebaseMountParameterGroups | Query the parameter templates attached to lakebase | Queries the parameter templates attached to Lakebase. |
| DescribeLakebaseMountParameterTemplateList | Query the parameter dictionary supported by parameter templates mounted to lakebase | Queries the parameter dictionary supported by parameter templates mounted to Lakebase. |
| ModifyLakebaseMountParameterGroup | Modify a mounted parameter template for lakebase | Modifies a mounted parameter template for Lakebase. |
| CreateAgenticDBTenant | Create an agenticDB tenant | Creates an AgenticDB tenant. |
| DeleteAgenticDBTenant | Delete an agenticDB tenant | Deletes an AgenticDB tenant. |
| DeleteAIDBClusterCustomModel | Delete a custom model registration for an AI cluster | Deletes a custom model registration for an AI cluster. |
| DescribeAgenticDBBranchRestoreWindow | Query the earliest restorable time for an agenticDB branch | Queries the earliest restorable time for an AgenticDB branch. |
| DescribeAgenticDBProjectHistoryRetention | Query the actual history retention window of an agenticDB project | Queries the actual history retention window of an AgenticDB project. |
| DescribeKBSyncLinkAttribute | Query knowledge base synchronization link details | Queries the details of a knowledge base synchronization link. |
| ModifyAgenticDBProjectHistoryRetention | Modify the history retention window of an agenticDB project | Modifies the history retention window of an AgenticDB project. |
| ModifyAIDBClusterModel | Modify AI cluster model or customer-facing invocation name | Modifies the AI cluster model or the customer-facing invocation name. |
| RegisterAIDBClusterCustomModel | Register a custom model for an AI cluster | Registers a custom model for an AI cluster. |
| ResetApplicationAccountPassword | Reset application password | Resets the password of an application account. |
| ResizeAIDBClusterModel | Adjust AI cluster model capacity | Adjusts the model capacity of an AI cluster. |
| DescribeSearchModifyParameterLog | Query polarDB search parameter modification history | Queries the parameter modification history of PolarDB Search. |
| DescribeSearchParameters | Query polarDB search cluster parameters | Queries the parameters of a PolarDB Search cluster. |
| ModifyApplicationSSL | Modify application SSL configuration | Modifies the SSL configuration of a specified PolarDB application. |
| ModifySearchParameters | Query polarDB search cluster parameters | Modifies the parameters of a PolarDB Search cluster. |