API overview
Updated at:
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 | ModifyAutoRenewAttribute | 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 | 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. |
| 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 cluster list | Queries the list of PolarDB clusters or the details of clusters with 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. |
| 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 | 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 | Disable cluster orca | Disables the relational algebra of 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 | Query PolarDB for MySQL cluster kernel version information | Queries the details of the current Milvus version of a PolarDB for MySQL cluster. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |
Whitelist management
|
API |
Title |
Description |
| DescribeDBClusterAccessWhitelist | 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 the whitelist of a cluster | 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. |
| 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 | 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 | 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 | DescribeEncryptionDBSecret | Queries encryption key information. |
| ModifyEncryptionDBSecret | Modify encryption key | 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 | Change the specifications of a single node in a polarDB cluster | Changes the specifications of a single node in a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| RestartDBNode | RestartDBNode | Restarts a node of 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 | ModifyDBClusterAndNodesParameters | Modify cluster parameters and apply 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 | 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 | 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 | 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 | Release a polarDB custom cluster endpoint | Releases a custom cluster endpoint of a PolarDB cluster. |
| DeleteDBEndpointAddress | DeleteDBEndpointAddress | Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint. |
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 | 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. |
| 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 | DeleteGlobalDatabaseNetwork | 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 | SwitchOverGlobalDatabaseNetwork | Switches over 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 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. |
| DescribeDetachedBackups | Query backup set details of 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 | DescribeBackupRegions | Queries the regions that store 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. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| ReactivateDBClusterBackup | ReactivateDBClusterBackup | Reactivates the backup feature. |
| Backup policy | Backup policy | |
| DescribeBackupPolicy | Query 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 | 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. |
| UntagResources | UntagResources | Detaches tags from a PolarDB cluster. |
| TagResources | TagResources | Adds tags to PolarDB clusters. |
| ListTagResources | ListTagResources | Queries the tags that are attached to one or more PolarDB clusters, or the PolarDB clusters that are attached to one or more tags. |
Pending 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 | View proactive O&M events | Retrieves the O&M configuration of a user, which currently includes 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 | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
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 | 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. |
| 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 | 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 | 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 | DeleteDBLink | Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for 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 | 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 | Query polarDB applications | Queries the 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 | Queries the details of a 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 | 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. |
| SearchMemories | Search application memories | Retrieves memories from a specified application. |
| 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 details of AI application logs. |
| 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 | Install polarClaw plug-in | Installs the PolarClaw plug-in. |
| EnablePolarClawPlugin | EnablePolarClawPlugin | Enables a PolarClaw plugin. |
| DisablePolarClawPlugin | DisablePolarClawPlugin | Disables the PolarClaw plugin. |
| UpgradePolarClawPlugin | Upgrade a polarClaw plug-in | Upgrades a plug-in in a PolarClaw application. |
| 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 | 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 | DescribeGatewayAttribute | Viewing gateway instance details |
| DeleteGateway | DeleteGateway | Deletes a gateway instance. |
| CreateBudgetPolicy | Create a budget policy | 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 | Create model API | Creates a routing rule. |
| DescribeModelApis | Query model aPIs | Queries model APIs. |
| ModifyModelApi | Modify a model API | Modifies a model API. |
| DeleteModelApi | DeleteModelApi | 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 | 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 | Query polarlakebase quota rules | Retrieves all quota rule information for a specified Polarlakebase instance. |
| SetPolarFsFileQuota | Apply quota rules to a directory | Sets file quota rules for a specified directory in a Polarlakebase 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 | Query polarlakebase global database network (GDN) details across all regions | Queries the details of Polarlakebase Global Database Networks (GDNs) across all regions. |
| 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 | Add bucket path mapping for polarFS transparent acceleration | Adds a transparent acceleration path. |
| DeletePolarFsPathMapping | Delete a polarFS transparent acceleration bucket path mapping | Deletes a transparent acceleration path mapping. |
AI cluster
|
API |
Title |
Description |
| DescribeAvailableModels | Retrieve models in an AI cluster | Retrieves a list of models in an AI cluster. |
| CreateAIDBClusterTask | Create a model creation operator instance | Creates a model creation operator instance. |
| DescribeAIDBClusterTasks | Query model operators | Queries the list of model operators for a specified PolarDB database instance. |
| DescribeAIDBClusters | List AI clusters | Queries the list of custom clusters. |
| DescribeAIDBClusterTaskAttribute | Query task details | Retrieves the details of a task instance. |
| CreateAIDBClusterDataset | CreateAIDBClusterDataset | Creates a dataset. |
| DescribeAIDBClusterDatasets | Query dataset list | Queries a list of datasets. |
| ModifyAIDBClusterDescription | ModifyAIDBClusterDescription | Modify the name of an AI instance |
| DescribeAIDBClusterAttribute | Query the detailed attributes 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 | Delete an AI cluster instance | Deletes an AI cluster instance. |
| DeleteAIDBClusterDataset | DeleteAIDBClusterDataset | Deletes a dataset. |
| DeleteAIDBClusterTask | DeleteAIDBClusterTask | 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 | Single-turn knowledge base Q&A | Performs a single-turn knowledge base question answering. |
| 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 | Query knowledge base synchronization list | Queries the list of knowledge base synchronization links. |
| UpdateKBSyncLink | Update a knowledge base synchronization link | Updates a knowledge base synchronization link. |
| 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 knowledge base files | Retries failed files in a knowledge base in batches. |
| RegisterKnowledgeBaseFile | Register a knowledge base OSS file | Registers an OSS file in a knowledge base. |
| DescribeKnowledgeBaseFileShards | List file shards in a knowledge base | Queries the list of file shards in a knowledge base. |
Service-linked role
|
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 | 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 | 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 | 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 ApsaraDB database name for PolarDB on ENS. |
| DescribeDBClusterVersionZonal | Query kernel version information of an edge cluster | Queries the version of a PolarDB on ENS 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 | Delete an account for an edge cluster | Deletes an account for a PolarDB on ENS cluster. |
| ModifyAccountDescriptionZonal | Modify the description of an edge cluster account | Modifies the description of an account in a PolarDB on ENS cluster. |
| 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 a PolarDB on ENS 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 | DescribeDatabasesZonal | Describes the databases in a PolarDB on ENS cluster. |
| 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 | DescribeDbClusterAttributeZonal | Queries the attributes of an PolarDB on ENS 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 | 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 | 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 | CreateActivationCode | Generates activation codes for the lightweight version. |
| DescribeActivationCodeDetails | DescribeActivationCodeDetails | Queries an activation code. |
| DescribeCrossCloudLevels | Query specifications supported for cross-cloud scenarios | Queries the list of specifications supported for cross-cloud scenarios. |
| 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 | 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. |
| CreateAIDBCluster | Create an AI cluster | Creates an AI cluster. |
| DescribePolarFs | Query polarFS cluster list | Queries PolarFS information. |
| DescribeSharedBackups | DescribeSharedBackups | Queries shared backup sets. |
| DescribeApplicationPerformance | Query polarDB AI application performance | Queries the performance of a PolarDB AI application. |
| OperateApplication | Manage a polarDB AI application | Restarts, pauses, or starts an application on a PolarDB instance without deleting the instance. |
| CreateBatchTask | CreateBatchTask | Creates a batch task. |
| DescribeBatchTask | DescribeBatchTask | Queries the status of a batch task. |
| DescribeBatchTasks | Query batch task status | Queries the status of batch tasks. |
| DescribePolarFsQuotaList | Query all quotas | Queries the quota list. |
| LoginPolarClawChannel | LoginPolarClawChannel | Logs into a PolarClaw channel. |
| RemovePolarClawDevicePair | RemovePolarClawDevicePair | Unpairs a PolarClaw device. |
| RejectPolarClawDevicePair | RejectPolarClawDevicePair | Rejects a PolarClaw device pairing request. |
| DescribePolarClawTask | DescribePolarClawTask | Queries the status of a PolarClaw asynchronous task. |
| ApprovePolarClawDevicePair | ApprovePolarClawDevicePair | Approves a PolarClaw device pairing. |
| ListPolarClawDevicePairs | ListPolarClawDevicePairs | List PolarClaw device pairings |
| DescribeGatewayApikeyList | Query all API keys under a UID | Queries all API keys under the current UID. |
| CreateBatchConsumer | Create gateway user API keys in batches | Creates API keys in batches. |
| DescribeApikeyAttribute | Query API key details | Queries the details of a specified API key. |
| DescribeDBClusterPrice | Query DB instance price | Queries the price of a cluster. |
| SearchPolarClawSkills | Search polarClaw skills | Searches for PolarClaw Skills. |
| InstallPolarClawSkill | Install polarClaw skill | Installs a PolarClaw Skill. |
| DescribePolarClawAgentFile | Query polarClaw agent file | Queries a PolarClaw Agent file. |
| UpdatePolarClawAgentTools | Update polarClaw agent tool configuration | Updates the tool configuration of a PolarClaw Agent. |
| UpdatePolarClawAgentSkills | Update polarClaw agent skills | 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 | Query agenticDB tenant API key list | Queries the list of API keys for an AgenticDB tenant. |
| DescribeAgenticDBProjects | Query agenticDB project list | 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 | Query agenticDB compute instances | Queries the list of AgenticDB compute instances. |
| DescribeAgenticDBBranchLineage | Query agenticDB branch lineage | Queries the branch lineage of an AgenticDB cluster. |
| DescribeAgenticDBBranches | Query agenticDB branch list | 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 branch connection information of an AgenticDB cluster. |
| 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 agenticDB tenant API key | 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 API key for an AgenticDB tenant. |
| DescribeApplicationSessionIds | Query AI application sessions | Queries AI application sessions. |
| AddPolarOSSAuthorizedAccount | Add cold storage authorized accounts | 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. |
| CreateAIDBClusterApiKey | Create a model serving API key | Creates a model creation service API key. |
| CreateApplicationAgentRelation | Bind an agent to a squad | Binds an Agent to a Squad. |
| 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. |
| CreateLakebaseS3Account | Create an S3 account | Creates a PolarFS S3 account. |
| 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 MaxCpu to specify the maximum CPU quota percentage that the rule can use, or set CpuCount to specify the maximum number of CPU cores that the rule can use. You must specify one and only one of MaxCpu and CpuCount when creating a rule. |
| DeleteAIDBClusterApiKey | Delete a model service API key | Deletes an API key for a model service. |
| DeleteLakebaseS3Account | Delete an S3 account | Deletes a PolarFS S3 account. |
| 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. |
| DescribeAIDBClusterApiKeys | Query model service API key | Queries the API key of a model service. |
| DescribeApplicationUsage | Query AI application usage | Queries the usage of an AI application. |
| DescribeLakebaseS3Account | Query S3 account details | Queries the details of a PolarFS S3 account. |
| DescribePolarFsMapping | Query polarFS path mappings | Queries the list of PolarFS path mappings. |
| GetLakebaseTenantToken | Retrieve lakebase tenant token | Retrieves the Lakebase tenant token (SPG tenant mount URL). |
| ListLakebaseS3Accounts | List S3 accounts | Lists PolarFS S3 accounts. |
| ModifyApplicationEndpointAddress | Modify a polarDB application endpoint address | Modifies a PolarDB application endpoint address. |
| ModifyPolarFsMappingAuth | Modify polarFS mapping credentials | Modifies the bucket credentials for a 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 percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters. |
| RestartAIDBCluster | Restart an AIDB cluster | Restarts an AI cluster. |
| RestartPolarClawGateway | Restart a polarClaw gateway | Restarts a PolarClaw gateway. |
| 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. |
| UpgradeApplicationVersion | Upgrade AI application minor version | Upgrades an application to a new version. |
| DescribeApplicationSSL | Query application SSL configuration | Queries the SSL configuration of an application. |
| DeleteAIDBClusterCustomModel | Delete a custom model registration for an AI cluster | Deletes a custom model registration for an AI cluster. |
| DescribeKBSyncLinkAttribute | Query knowledge base synchronization link details | Queries the details of a knowledge base synchronization link. |
| ModifyAIDBClusterModel | Modify the 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. |
| ResizeAIDBClusterModel | Adjust AI cluster model capacity | Adjusts the model capacity of an AI cluster. |
Is this page helpful?