API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (polardb/2017-08-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
AI gateway
|
API |
Title |
Description |
| CreateGateway | CreateGateway | Creates a gateway instance. |
| DescribeGatewayList | DescribeGatewayList | Queries a list of gateway instances. |
| DescribeGatewayAttribute | DescribeGatewayAttribute | Viewing gateway instance details |
| DeleteGateway | DeleteGateway | Deletes a gateway instance. |
| CreateBudgetPolicy | CreateBudgetPolicy | Creates a budget policy. |
| DescribeBudgetPolicies | DescribeBudgetPolicies | Querying budget policies |
| ModifyBudgetPolicy | ModifyBudgetPolicy | Modifies a budget policy. |
| DeleteBudgetPolicy | DeleteBudgetPolicy | Deletes a budget policy. |
| CreateRateLimitPolicy | CreateRateLimitPolicy | Creates a rate limiting policy. |
| DescribeRateLimitPolicy | DescribeRateLimitPolicy | Queries rate limit policies. |
| ModifyRateLimitPolicy | ModifyRateLimitPolicy | Modifies a rate limit policy. |
| DeleteRateLimitPolicy | DeleteRateLimitPolicy | Deletes a rate limit policy. |
| CreateModelService | CreateModelService | Creates a model service. |
| DescribeModelServices | DescribeModelServices | List model services |
| ModifyModelService | ModifyModelService | Modifies a model service. |
| DeleteModelService | DeleteModelService | Deletes a specified model service. |
| CreateModelApi | CreateModelApi | Creates a model API. |
| DescribeModelApis | DescribeModelApis | Model Query API |
| ModifyModelApi | ModifyModelApi | Modifies a model API. |
| DeleteModelApi | DeleteModelApi | Deletes a model API. |
| CreateCostRule | CreateCostRule | Creates a cost rule. |
| DescribeCostRules | DescribeCostRules | Queries cost rules. |
| ModifyCostRule | ModifyCostRule | Modifies a cost rule. |
| DeleteCostRule | DeleteCostRule | Deletes a cost rule. |
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group. |
| DescribeConsumerGroups | DescribeConsumerGroups | Retrieves a list of consumer groups. |
| ModifyConsumerGroup | ModifyConsumerGroup | Modifies a consumer group. |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a consumer group. |
| CreateConsumer | CreateConsumer | Creates a consumer. |
| DescribeConsumers | DescribeConsumers | Returns a list of consumers. |
| ModifyConsumer | ModifyConsumer | Modifies the properties of a consumer. |
| DeleteConsumer | DeleteConsumer | Deletes a consumer. |
| ResetConsumerApiKey | ResetConsumerApiKey | Resets an api key. |
Others
|
API |
Title |
Description |
| AbortDBClusterMigration | AbortDBClusterMigration | Aborts an upgrade or migration task. |
| AddEncryptionDBRolePrivilege | AddEncryptionDBRolePrivilege | Grants permissions to a role. |
| AddFirewallRules | AddFirewallRules | Adds SQL firewall rules. |
| AddPolarClawMCPServer | AddPolarClawMCPServer | Adds an MCP server to a specified PolarClaw application. |
| AddPolarFsPathMapping | AddPolarFsPathMapping | Adds a transparent acceleration path. |
| AddPolarFsQuota | AddPolarFsQuota | Adds a new directory quota rule to a Polarlakebase instance. |
| AddSQLRateLimitingRules | AddSQLRateLimitingRules | Adds SQL throttling rules. |
| ApplyApplicationPrompts | ApplyApplicationPrompts | Applies prompts to an application instance. |
| ApprovePolarClawDevicePair | ApprovePolarClawDevicePair | Approves a PolarClaw device pairing. |
| AttachApplicationPolarFS | AttachApplicationPolarFS | Attaches a specified PolarLakeBase cold-storage instance to a PolarDB application. |
| BindPolarClawAgent | BindPolarClawAgent | Binds a PolarClaw Agent to a channel. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
| CancelCronJobPolicyServerless | CancelCronJobPolicyServerless | Cancels an auto triggered task policy. |
| CancelPolarFsFileQuota | CancelPolarFsFileQuota | Deletes quota rules for one or more file paths within a specified Polarlakebase instance. |
| CancelScheduleTasks | CancelScheduleTasks | Cancels scheduled tasks that have not started. |
| CheckAccountName | CheckAccountName | Checks whether an account name is valid or unique in a cluster. |
| CheckAccountNameZonal | CheckAccountNameZonal | Checks a PolarDB account name. |
| CheckConnectionString | CheckConnectionString | Checks the connection string of a cluster. |
| CheckDBName | CheckDBName | Checks whether a database name is valid or if a database with the same name already exists in the current cluster. |
| CheckDBNameZonal | CheckDBNameZonal | Checks the name of a database in an edge cluster for PolarDB on ENS. |
| CheckKMSAuthorized | CheckKMSAuthorized | Checks whether a user is authorized to use Key Management Service (KMS). |
| CheckPolarFsQuotaConsistency | CheckPolarFsQuotaConsistency | Checks the consistency of quota settings in a PolarFS instance. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role has been created. |
| ClonePolarFsBasicSnapshot | ClonePolarFsBasicSnapshot | Clones a snapshot of a file or folder for a Basic Edition instance. |
| CloseAITask | CloseAITask | Disables the PolarDB for AI feature. |
| CloseDBClusterMigration | CloseDBClusterMigration | Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster. |
| ContinueDBClusterMigration | ContinueDBClusterMigration | Continues the current migration or upgrade task. |
| CreateAIDBCluster | CreateAIDBCluster | Create an AI cluster. |
| CreateAIDBClusterDataset | CreateAIDBClusterDataset | Creates a dataset. |
| CreateAIDBClusterTask | CreateAIDBClusterTask | Creates a model operator instance. |
| CreateAINodes | CreateAINodes | Creates AI nodes. |
| CreateAccount | CreateAccount | Creates a database account for a PolarDB cluster. |
| CreateAccountZonal | CreateAccountZonal | Creates an account for a PolarDB on ENS cluster. |
| CreateActivationCode | CreateActivationCode | Generates activation codes for the lightweight version. |
| CreateApplication | CreateApplication | Creates an application attached to a PolarDB instance. |
| CreateApplicationEndpointAddress | CreateApplicationEndpointAddress | Creates a connection address for a specified application. |
| CreateApplicationPrompt | CreateApplicationPrompt | Creates a Prompt for an Application. |
| CreateBackup | CreateBackup | Creates a full snapshot backup for a PolarDB cluster. |
| CreateBatchTask | CreateBatchTask | Creates a batch task. |
| CreateColdStorageInstance | CreateColdStorageInstance | Creates a cold storage instance. |
| CreateCronJobPolicyServerless | CreateCronJobPolicyServerless | Creates a scheduled task policy for a serverless cluster. |
| CreateDBCluster | CreateDBCluster | Creates a db cluster. |
| CreateDBClusterEndpoint | CreateDBClusterEndpoint | Creates a custom cluster endpoint for a PolarDB cluster. |
| CreateDBClusterEndpointZonal | CreateDBClusterEndpointZonal | Edge Cloud API: Create Link Address |
| CreateDBEndpointAddress | CreateDBEndpointAddress | Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint of a PolarDB cluster. |
| CreateDBLink | CreateDBLink | Creates a DBLink. |
| CreateDBNodes | CreateDBNodes | Add read-only nodes to a PolarDB cluster. |
| CreateDatabase | CreateDatabase | Creates a database for a PolarDB cluster. |
| CreateDatabaseZonal | CreateDatabaseZonal | Creates a database of an edge cluster for PolarDB on ENS. |
| CreateExtensions | CreateExtensions | Creates one or more extensions. |
| CreateGlobalDataNetwork | CreateGlobalDataNetwork | Create a new PolarLakeBase Global Data Network (GDN). |
| CreateGlobalDatabaseNetwork | CreateGlobalDatabaseNetwork | Creates a new global database network (GDN). |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| CreateNetworkChannel | CreateNetworkChannel | Creates a network channel. |
| CreateOrGetVirtualLicenseOrder | CreateOrGetVirtualLicenseOrder | Creates or obtains a virtual license order. |
| CreateParameterGroup | CreateParameterGroup | Creates a PolarDB parameter template. |
| CreatePolarClawAgent | CreatePolarClawAgent | Creates a PolarClaw Agent. |
| CreatePolarClawChannel | CreatePolarClawChannel | Creates a channel in PolarClaw. |
| CreatePolarClawCronJob | CreatePolarClawCronJob | Creates a PolarClaw scheduled task. |
| CreatePolarFsObject | CreatePolarFsObject | Creates a new directory in a specified PolarFS instance. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Ccreates a service-linked role. |
| CreateStoragePlan | CreateStoragePlan | Purchases a storage plan. |
| DeleteAIDBCluster | DeleteAIDBCluster | Deletes an AI cluster instance. |
| DeleteAIDBClusterDataset | DeleteAIDBClusterDataset | Deletes a dataset. |
| DeleteAIDBClusterTask | DeleteAIDBClusterTask | Deletes a task instance. |
| DeleteAINodes | DeleteAINodes | Deletes child nodes of an AI instance. |
| DeleteAccount | DeleteAccount | Deletes a PolarDB database account. |
| DeleteAccountZonal | DeleteAccountZonal | Deletes an account from an edge cluster for PolarDB on ENS. |
| DeleteApplication | DeleteApplication | Deletes the specified PolarDB application. This operation does not delete the associated PolarDB instance. |
| DeleteApplicationEndpointAddress | DeleteApplicationEndpointAddress | Deletes a specified connection address for a PolarDB application. |
| DeleteApplicationPrompt | DeleteApplicationPrompt | Deletes an application prompt. |
| DeleteBackup | DeleteBackup | Deletes the backup sets of a PolarDB cluster. |
| DeleteDBCluster | DeleteDBCluster | Deletes a pay-as-you-go PolarDB cluster. |
| DeleteDBClusterEndpoint | DeleteDBClusterEndpoint | Deletes a custom cluster endpoint for a PolarDB cluster. |
| DeleteDBClusterEndpointZonal | DeleteDBClusterEndpointZonal | Deletes a cluster endpoint of a PolarDB for Edge cluster. |
| DeleteDBEndpointAddress | DeleteDBEndpointAddress | Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint. |
| DeleteDBLink | DeleteDBLink | Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster. |
| DeleteDBNodes | DeleteDBNodes | Deletes read-only nodes from a PolarDB cluster. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a PolarDB cluster. |
| DeleteDatabaseZonal | DeleteDatabaseZonal | Deletes a database from a PolarDB edge cloud cluster. |
| DeleteEncryptionDBRolePrivilege | DeleteEncryptionDBRolePrivilege | Deletes a role. |
| DeleteExtensions | DeleteExtensions | Deletes an extension. |
| DeleteFirewallRules | DeleteFirewallRules | Deletes the specified SQL firewall rules. |
| DeleteGlobalDataNetwork | DeleteGlobalDataNetwork | Deletes a Polarlakebase Global Data Network (GDN). |
| DeleteGlobalDatabaseNetwork | DeleteGlobalDatabaseNetwork | Deletes a global database network (GDN). |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| DeleteMaskingRules | DeleteMaskingRules | Deletes the specified data masking rules. |
| DeleteNetworkChannel | DeleteNetworkChannel | Deletes a network channel. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a PolarDB parameter template. |
| DeletePolarClawAgent | DeletePolarClawAgent | This operation removes an agent and its associated bindings from a specified PolarClaw. |
| DeletePolarClawChannel | DeletePolarClawChannel | Deletes a PolarClaw Channel. |
| DeletePolarClawCronJob | DeletePolarClawCronJob | Deletes a PolarClaw cron job. |
| DeletePolarFsObjects | DeletePolarFsObjects | Deletes PolarLakebase files. This operation supports only the basic edition and cold storage edition. |
| DeletePolarFsPathMapping | DeletePolarFsPathMapping | Deletes a path mapping for transparent acceleration. |
| DeletePolarFsQuota | DeletePolarFsQuota | Deletes one or more quota rules from a specified Polarlakebase instance. |
| DeleteSQLRateLimitingRules | DeleteSQLRateLimitingRules | Deletes SQL throttling rules. |
| DescribeAIDBClusterAttribute | DescribeAIDBClusterAttribute | Gets the details of a custom instance. |
| DescribeAIDBClusterDatasets | DescribeAIDBClusterDatasets | Query datasets |
| DescribeAIDBClusterPerformance | DescribeAIDBClusterPerformance | Retrieves the performance metrics of an AI container. |
| DescribeAIDBClusterTaskAttribute | DescribeAIDBClusterTaskAttribute | Get task instance details |
| DescribeAIDBClusterTaskLogFiles | DescribeAIDBClusterTaskLogFiles | Queries the logs of model operators. |
| DescribeAIDBClusterTaskMetrics | DescribeAIDBClusterTaskMetrics | Queries the metrics of model operators. |
| DescribeAIDBClusterTasks | DescribeAIDBClusterTasks | Retrieves a list of model operators for a specified PolarDB instance. |
| DescribeAIDBClusters | DescribeAIDBClusters | View custom clusters. |
| DescribeAITaskStatus | DescribeAITaskStatus | Retrieves the status of the PolarDB for AI feature. |
| DescribeAccounts | DescribeAccounts | Queries a database account of a PolarDB cluster. |
| DescribeAccountsZonal | DescribeAccountsZonal | Queries the edge clusters for PolarDB on ENS. |
| DescribeActivationCodeDetails | DescribeActivationCodeDetails | Queries an activation code. |
| DescribeActivationCodes | DescribeActivationCodes | Retrieves a paginated list of activation codes associated with your account. You can filter the results by order ID or specific hardware identifiers. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the Operations and Maintenance (O&M) configuration for a user, including the active O&M window. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries operation and maintenance events for instances. |
| DescribeApplicationAttribute | DescribeApplicationAttribute | Retrieves details for a specific application in a PolarDB instance. |
| DescribeApplicationLogs | DescribeApplicationLogs | AI Application Log Details |
| DescribeApplicationParameters | DescribeApplicationParameters | Retrieves the current parameters and template information for a specified application and its components. |
| DescribeApplicationPerformance | DescribeApplicationPerformance | Querying PolarDB AI application performance. |
| DescribeApplicationPrompts | DescribeApplicationPrompts | Lists the Application Prompts for a specific Application. |
| DescribeApplicationServerlessConf | DescribeApplicationServerlessConf | Queries the Serverless configuration for a PolarDB application. |
| DescribeApplications | DescribeApplications | This operation queries the applications of all PolarDB instances in a specified region. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Describes the auto-renewal status of a subscription PolarDB cluster. |
| DescribeAvailableCrossRegions | DescribeAvailableCrossRegions | Retrieves a list of regions available for cross-region backup. |
| DescribeAvailableModels | DescribeAvailableModels | Lists the available models in an AI cluster. |
| DescribeBackupLogs | DescribeBackupLogs | Queries a list of backup logs and returns their download URLs. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the automatic backup policy of a PolarDB cluster. |
| DescribeBackupRegions | DescribeBackupRegions | Queries the regions that store backup sets. |
| DescribeBackupTasks | DescribeBackupTasks | Retrieves a list of backup jobs and their details for a cluster. |
| DescribeBackups | DescribeBackups | Queries backup information for a PolarDB cluster. |
| DescribeBatchTask | DescribeBatchTask | Retrieves the status and details of a batch task. |
| DescribeBatchTasks | DescribeBatchTasks | Queries the status of batch tasks. |
| DescribeCharacterSetName | DescribeCharacterSetName | Queries the character sets supported by PolarDB for MySQL. |
| DescribeClassList | DescribeClassList | Lists the available cluster specifications. |
| DescribeColdStorageInstance | DescribeColdStorageInstance | Queries cold storage instances. |
| DescribeCronJobPolicyServerless | DescribeCronJobPolicyServerless | Queries the policies for automatically triggered tasks. |
| DescribeCrossCloudLevels | DescribeCrossCloudLevels | Queries the supported cross-cloud specifications. |
| DescribeCrossCloudRegion | DescribeCrossCloudRegion | Queries cross-cloud regions. |
| DescribeCrossCloudRegionMappingToAliyun | DescribeCrossCloudRegionMappingToAliyun | This operation queries cross-cloud region mappings. |
| DescribeDBClusterAccessWhitelist | DescribeDBClusterAccessWhitelist | Queries the IP address whitelists and security groups of a PolarDB cluster. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries the attributes of a specified cluster. |
| DescribeDBClusterAuditLogCollector | DescribeDBClusterAuditLogCollector | Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer. |
| DescribeDBClusterAvailableResources | DescribeDBClusterAvailableResources | Queries available resources in a PolarDB cluster. |
| DescribeDBClusterConnectivity | DescribeDBClusterConnectivity | Checks whether a database cluster is accessible from a source IP address. |
| DescribeDBClusterEncryptionKey | DescribeDBClusterEncryptionKey | Queries the key usage details for a specified PolarDB cluster. |
| DescribeDBClusterEndpoints | DescribeDBClusterEndpoints | Queries the endpoints of a PolarDB cluster. |
| DescribeDBClusterEndpointsZonal | DescribeDBClusterEndpointsZonal | Queries the endpoints of an edge cluster for PolarDB on ENS. |
| DescribeDBClusterMigration | DescribeDBClusterMigration | Queries the migration status of a PolarDB cluster. |
| DescribeDBClusterMonitor | DescribeDBClusterMonitor | Queries the interval at which the monitoring data of a PolarDB cluster is collected. |
| DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | Queries database endpoints. |
| DescribeDBClusterParameters | DescribeDBClusterParameters | Queries the list of running parameters for a PolarDB cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of a PolarDB cluster. |
| DescribeDBClusterProxy | DescribeDBClusterProxy | Queries a database cluster proxy. |
| DescribeDBClusterSSL | DescribeDBClusterSSL | Queries the SSL settings of a PolarDB cluster. |
| DescribeDBClusterServerlessConf | DescribeDBClusterServerlessConf | Queries the configuration of a serverless cluster. |
| DescribeDBClusterTDE | DescribeDBClusterTDE | Queries the transparent data encryption (TDE) settings for a specified PolarDB cluster. |
| DescribeDBClusterVersion | DescribeDBClusterVersion | Retrieves the details of the current kernel version for a PolarDB for MySQL cluster. |
| DescribeDBClusterVersionZonal | DescribeDBClusterVersionZonal | Queries the version of a PolarDB edge cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries the details of PolarDB clusters, including clusters that you are authorized to access through Resource Access Management (RAM). |
| DescribeDBClustersWithBackups | DescribeDBClustersWithBackups | Queries PolarDB clusters in a region that have backup sets. |
| DescribeDBClustersZonal | DescribeDBClustersZonal | Lists the PolarDB clusters in MyBase. |
| DescribeDBInitializeVariable | DescribeDBInitializeVariable | Queries the supported character sets, collations, and other properties of a PolarDB database. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance monitoring data for a compute node. |
| DescribeDBLinks | DescribeDBLinks | Queries the database links of a PolarDB for Oracle cluster. |
| DescribeDBLogFiles | DescribeDBLogFiles | Queries the logs of a PolarDB cluster, such as primary/secondary failover logs. |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries the available minor engine versions. |
| DescribeDBNodePerformance | DescribeDBNodePerformance | Queries performance data for a node in a PolarDB cluster. |
| DescribeDBNodesParameters | DescribeDBNodesParameters | Queries the parameters for specified nodes in a cluster. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of PolarProxy. |
| DescribeDasConfig | DescribeDasConfig | Queries the configurations of a cluster in Database Autonomy Service (DAS). |
| DescribeDatabases | DescribeDatabases | Queries for the details of databases in a specified PolarDB cluster. |
| DescribeDatabasesZonal | DescribeDatabasesZonal | Describes the databases in a PolarDB on ENS cluster. |
| DescribeDbClusterAttributeZonal | DescribeDbClusterAttributeZonal | Queries the attributes of an PolarDB on ENS cluster. |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the information about the backup sets in a released PolarDB cluster. |
| DescribeEncryptionDBRolePrivilege | DescribeEncryptionDBRolePrivilege | Queries a list of permissions for a database role. |
| DescribeEncryptionDBSecret | DescribeEncryptionDBSecret | Queries encryption key information. |
| DescribeExtensions | DescribeExtensions | Retrieves the details of extensions. |
| DescribeFirewallRules | DescribeFirewallRules | Describes SQL firewall rules. |
| DescribeGlobalDataNetworkList | DescribeGlobalDataNetworkList | Retrieves details for Polarlakebase Global Data Networks (GDNs) across all regions in your account. |
| DescribeGlobalDatabaseNetwork | DescribeGlobalDatabaseNetwork | Retrieves details for a Global Database Network (GDN). |
| DescribeGlobalDatabaseNetworks | DescribeGlobalDatabaseNetworks | View details for all Global Database Networks (GDNs) in your account. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the relationship between a cluster and a global IP whitelist template. |
| DescribeHALogs | DescribeHALogs | Queries high availability (HA) logs for an instance. |
| DescribeHistoryEvents | DescribeHistoryEvents | Lists the historical events in Event Center. |
| DescribeHistoryTasks | DescribeHistoryTasks | Retrieves a list of historical administrative tasks for PolarDB for MySQL instances, such as parameter changes, and instance restarts. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries task statistics in Task Center. |
| DescribeLicenseOrderDetails | DescribeLicenseOrderDetails | Queries a license order. |
| DescribeLicenseOrders | DescribeLicenseOrders | This operation queries a list of license orders. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | Queries the available time range to recover from a backup. |
| DescribeLogBackupPolicy | DescribeLogBackupPolicy | Queries the data retention policy for the log backups of a PolarDB cluster. |
| DescribeMaskingRules | DescribeMaskingRules | Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule. |
| DescribeMetaList | DescribeMetaList | Queries recoverable databases and tables. |
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the modification history of parameters. |
| DescribeNetworkChannel | DescribeNetworkChannel | Queries network channels. |
| DescribeParameterGroup | DescribeParameterGroup | Retrieves the details of a specified parameter template. |
| DescribeParameterGroups | DescribeParameterGroups | This operation queries the parameter templates in a specified region. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the default parameters of a database cluster. |
| DescribePendingMaintenanceAction | DescribePendingMaintenanceAction | Queries the information about a pending event. |
| DescribePendingMaintenanceActions | DescribePendingMaintenanceActions | Retrieves a count of pending events for various task types. |
| DescribePolarAgentChatRecords | DescribePolarAgentChatRecords | Queries the chat records of a specified session. |
| DescribePolarAgentSessionStatus | DescribePolarAgentSessionStatus | Queries the status of a session. |
| DescribePolarAgentUserSessions | DescribePolarAgentUserSessions | Queries historical session records. |
| DescribePolarClawAgents | DescribePolarClawAgents | Queries the details of agents installed in a specified application. |
| DescribePolarClawChannels | DescribePolarClawChannels | Lists all installed PolarClaw channels and their status information. |
| DescribePolarClawCronJobs | DescribePolarClawCronJobs | Query all or specific scheduled tasks in PolarClaw and their details. |
| DescribePolarClawMCPServers | DescribePolarClawMCPServers | Lists all installed PolarClaw MCP services and their configurations. |
| DescribePolarClawPlugins | DescribePolarClawPlugins | Lists all installed PolarClaw plugins and their status. |
| DescribePolarClawTask | DescribePolarClawTask | Queries the status of a PolarClaw asynchronous task. |
| DescribePolarFsAttribute | DescribePolarFsAttribute | Gets the details of a PolarFS instance. |
| DescribePolarFsObjects | DescribePolarFsObjects | Lists the files and subdirectories at a specified path. |
| DescribePolarFsQuota | DescribePolarFsQuota | Retrieves all quota rules for a specified PolarFileSystem (PolarFS) instance. |
| DescribePolarFsQuotaList | DescribePolarFsQuotaList | Retrieves the quota list. |
| DescribePolarSQLCollectorPolicy | DescribePolarSQLCollectorPolicy | Checks whether the SQL Explorer feature is enabled for a target cluster. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | Describes a list of VPCs. |
| DescribeRegions | DescribeRegions | Queries the regions and zones that are supported by PolarDB. |
| DescribeResourcePackages | DescribeResourcePackages | Describes cross-cloud resource plans. |
| DescribeSQLRateLimitingRules | DescribeSQLRateLimitingRules | Returns the details of SQL throttling rules. |
| DescribeScheduleTasks | DescribeScheduleTasks | Retrieves the details of all scheduled tasks. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of slow query logs for a PolarDB cluster. |
| DescribeSlowLogs | DescribeSlowLogs | Queries the slow query log statistics for a PolarDB cluster. |
| DescribeTasks | DescribeTasks | Queries the progress details of tasks generated by API calls, such as creating a cluster. |
| DescribeUpgradeReport | DescribeUpgradeReport | Queries the verification reports. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Retrieves a list of Key Management Service (KMS) keys. |
| DescribeVSwitchList | DescribeVSwitchList | Retrieves information about vSwitches. |
| DescribeVSwitches | DescribeVSwitches | Queries one or more vSwitches. |
| DescribeVpcs | DescribeVpcs | Queries one or more VPCs. |
| DescribeZones | DescribeZones | Queries the available zones. |
| DisableDBClusterDynamoDB | DisableDBClusterDynamoDB | Disables DynamoDB compatibility. |
| DisableDBClusterOrca | DisableDBClusterOrca | Disables the Orca (Redis-compatible) feature for a PolarDB cluster. |
| DisableDBClusterServerless | DisableDBClusterServerless | Disables the Serverless feature for a cluster. |
| DisablePolarClawChannel | DisablePolarClawChannel | This API disables a specified PolarClaw channel. |
| DisablePolarClawCronJob | DisablePolarClawCronJob | Disables a PolarClaw cron job. |
| DisablePolarClawPlugin | DisablePolarClawPlugin | Disables the PolarClaw plugin. |
| EnableDBClusterDynamoDB | EnableDBClusterDynamoDB | Enables DynamoDB compatibility. |
| EnableDBClusterOrca | EnableDBClusterOrca | Enables the Orca (Redis-compatible) feature for a PolarDB cluster. |
| EnableDBClusterServerless | EnableDBClusterServerless | Enables the Serverless feature for a cluster. |
| EnableFirewallRules | EnableFirewallRules | Modifies the status of SQL firewall rules for a cluster. |
| EnablePolarClawChannel | EnablePolarClawChannel | Enables a PolarClaw channel. |
| EnablePolarClawCronJob | EnablePolarClawCronJob | Enables a cron job in PolarClaw. |
| EnablePolarClawPlugin | EnablePolarClawPlugin | Enables a PolarClaw plugin. |
| EnableSQLRateLimitingRules | EnableSQLRateLimitingRules | Enables or disables SQL throttling rules. |
| EvaluateRegionResource | EvaluateRegionResource | Evaluates the resources in a region. |
| ExecuteCrossCloudOpenAPI | ExecuteCrossCloudOpenAPI | Calls a cross-cloud OpenAPI. |
| FailoverDBCluster | FailoverDBCluster | Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster. |
| FailoverDBClusterZonal | FailoverDBClusterZonal | Initiates a zonal failover for a PolarDB cluster, promoting a secondary node to primary. |
| GenerateUpgradeReportForSyncClone | GenerateUpgradeReportForSyncClone | Generates a report for a pre-upgrade check. |
| GetPolarAgent | GetPolarAgent | Creates a chat record. |
| GetPolarClawConfig | GetPolarClawConfig | Retrieves the PolarClaw configuration. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster. |
| GrantAccountPrivilegeZonal | GrantAccountPrivilegeZonal | Modifies the account permissions on a PolarDB for Xscale cluster. |
| InstallPolarClawPlugin | InstallPolarClawPlugin | Installs a PolarClaw plugin. |
| ListOrders | ListOrders | Queries a list of orders. |
| ListPolarClawBindings | ListPolarClawBindings | Lists PolarClaw bindings. |
| ListPolarClawDevicePairs | ListPolarClawDevicePairs | List PolarClaw device pairings |
| ListTagResources | ListTagResources | Queries the tags that are attached to one or more PolarDB clusters, or the PolarDB clusters that are attached to one or more tags. |
| ListTagResourcesForRegion | ListTagResourcesForRegion | Queries the tags that are attached to resources in a specified region. |
| LoginPolarClawChannel | LoginPolarClawChannel | Logs into a PolarClaw channel. |
| ManuallyStartDBCluster | ManuallyStartDBCluster | Starts a DB cluster. |
| ModifyAIDBClusterDescription | ModifyAIDBClusterDescription | Modify the name of an AI instance |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a PolarDB database account. |
| ModifyAccountDescriptionZonal | ModifyAccountDescriptionZonal | Modifies the description of a PolarDB on ENS account. |
| ModifyAccountLockState | ModifyAccountLockState | Changes the lock status of a PolarDB database account. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a database account for a specified PolarDB cluster. |
| ModifyAccountPasswordZonal | ModifyAccountPasswordZonal | Modifies the password of an account in a PolarDB for Xscale cluster. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Configures the operations and maintenance (O&M) settings for a user. These settings include the active maintenance window. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\&M events for an instance. |
| ModifyApplicationDescription | ModifyApplicationDescription | Updates the description of a PolarDB application. |
| ModifyApplicationParameter | ModifyApplicationParameter | Modifies the configuration parameters of a sub-component within a specified PolarDB application. |
| ModifyApplicationPrompt | ModifyApplicationPrompt | Modifies the prompt for a specified application. |
| ModifyApplicationServerlessConf | ModifyApplicationServerlessConf | Modifies the Serverless configuration of a PolarDB application. |
| ModifyApplicationWhitelist | ModifyApplicationWhitelist | Modifies the IP address whitelist and security group configuration for a PolarDB application. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Sets the auto-renewal status for a subscription PolarDB cluster. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy for a PolarDB cluster. |
| ModifyCronJobPolicyServerless | ModifyCronJobPolicyServerless | Modifies the policy for a scheduled task. |
| ModifyDBCluster | ModifyDBCluster | Modify the feature configuration of a PolarDB MySQL cluster. |
| ModifyDBClusterAccessWhitelist | ModifyDBClusterAccessWhitelist | Creates or modifies the access whitelist for a cluster. The whitelist can be an IP address whitelist or a security group. |
| ModifyDBClusterAndNodesParameters | ModifyDBClusterAndNodesParameters | Modify cluster parameters and apply them to specified nodes. |
| ModifyDBClusterArch | ModifyDBClusterArch | Modifies the high-availability mode of a cluster. |
| ModifyDBClusterAuditLogCollector | ModifyDBClusterAuditLogCollector | Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer. |
| ModifyDBClusterDeletion | ModifyDBClusterDeletion | Enables or disables the cluster lock. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the description of a PolarDB cluster. |
| ModifyDBClusterDescriptionZonal | ModifyDBClusterDescriptionZonal | Modifies the description of a cluster. |
| ModifyDBClusterEndpoint | ModifyDBClusterEndpoint | This operation modifies the properties of a PolarDB cluster endpoint. You can configure settings such as the read/write mode, automatic node addition, consistency level, transaction splitting, the connection pool, and whether the primary node accepts read requests. |
| ModifyDBClusterEndpointZonal | ModifyDBClusterEndpointZonal | Modifies the connection string for an edge cluster for PolarDB on ENS. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the routine maintenance window for a PolarDB cluster. |
| ModifyDBClusterMigration | ModifyDBClusterMigration | Switches or rolls back a migration task for a one-click upgrade from RDS to PolarDB. |
| ModifyDBClusterMigrationEndpoint | ModifyDBClusterMigrationEndpoint | Modifies the source and target instances of a Data Transmission Service (DTS) task. |
| ModifyDBClusterMonitor | ModifyDBClusterMonitor | Modifies the interval at which the monitoring data of a PolarDB cluster is collected. |
| ModifyDBClusterParameters | ModifyDBClusterParameters | Modifies the parameters of a PolarDB cluster or applies an existing parameter template to a destination cluster. |
| ModifyDBClusterPrimaryZone | ModifyDBClusterPrimaryZone | Changes the primary zone of a PolarDB cluster. |
| ModifyDBClusterResourceGroup | ModifyDBClusterResourceGroup | Modifies the resource group of a database cluster. |
| ModifyDBClusterSSL | Configure cluster SSL | Enables or disables SSL encryption for a PolarDB cluster, or updates its CA certificate. |
| ModifyDBClusterServerlessConf | ModifyDBClusterServerlessConf | Modifies the configuration of a serverless cluster. |
| ModifyDBClusterStoragePerformance | ModifyDBClusterStoragePerformance | Modifies the storage performance of a PolarDB for MySQL cluster. |
| ModifyDBClusterStorageSpace | ModifyDBClusterStorageSpace | This operation modifies the storage space for pay-as-you-go enterprise edition and standard edition clusters. |
| ModifyDBClusterTDE | ModifyDBClusterTDE | ModifyDBClusterTDE |
| ModifyDBClusterVpc | ModifyDBClusterVpc | Modifies the vSwitch parameters for a cluster. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of a database in a PolarDB for MySQL cluster. |
| ModifyDBDescriptionZonal | ModifyDBDescriptionZonal | Modifies the database description of an edge cluster for PolarDB on ENS. |
| 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. |
| ModifyDBNodeClass | ModifyDBNodeClass | Modifies the node specifications of a PolarDB cluster. |
| ModifyDBNodeConfig | ModifyDBNodeConfig | Modifies the configuration of a node in a PolarDB cluster. |
| ModifyDBNodeDescription | ModifyDBNodeDescription | Modifies the name of a node in a PolarDB cluster. |
| ModifyDBNodeHotReplicaMode | ModifyDBNodeHotReplicaMode | Enables or disables the failover with hot replica feature for a node in a cluster. |
| ModifyDBNodeSccMode | ModifyDBNodeSccMode | Modifies the Snapshot Consistency Cluster (SCC) mode for a specified node in a PolarDB cluster. |
| ModifyDBNodesClass | ModifyDBNodesClass | Modifies the specifications of a single node in a PolarDB cluster. |
| ModifyDBNodesParameters | ModifyDBNodesParameters | Modifies and applies the parameters of one or more nodes. |
| ModifyEncryptionDBRolePrivilege | ModifyEncryptionDBRolePrivilege | Modifies role permissions. |
| ModifyEncryptionDBSecret | ModifyEncryptionDBSecret | Modifies an encryption policy. |
| ModifyFirewallRules | ModifyFirewallRules | Modifies the configuration of the SQL firewall. |
| ModifyGlobalDatabaseNetwork | ModifyGlobalDatabaseNetwork | Modifies a global database network (GDN). |
| 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. |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup retention policy for a PolarDB cluster. |
| ModifyMaskingRules | ModifyMaskingRules | Modifies or creates data masking rules. |
| ModifyPendingMaintenanceAction | ModifyPendingMaintenanceAction | Modifies the switching time of a pending event. |
| ModifyResourcePackage | ModifyResourcePackage | Modifies a cross-cloud resource plan. |
| ModifySQLRateLimitingRules | ModifySQLRateLimitingRules | Modifies SQL throttling rules. |
| ModifyScheduleTask | ModifyScheduleTask | Modifies the specified scheduled task. |
| MovePolarFsObjects | MovePolarFsObjects | Renames or moves files in a PolarFs instance. |
| OpenAITask | OpenAITask | Enables the PolarDB for AI feature. |
| PatchPolarClawConfig | PatchPolarClawConfig | Updates a PolarClaw configuration. |
| ReactivateDBClusterBackup | ReactivateDBClusterBackup | Reactivates the backup feature. |
| RefreshDBClusterStorageUsage | RefreshDBClusterStorageUsage | Refreshes the storage usage for a cluster instance. |
| RejectPolarClawDevicePair | RejectPolarClawDevicePair | Rejects a PolarClaw device pairing request. |
| RemoveApplicationEnvironmentVariables | RemoveApplicationEnvironmentVariables | Removes application environment variables. This operation supports only PolarClaw. |
| RemoveDBClusterFromGDN | RemoveDBClusterFromGDN | Removes a secondary cluster from a Global Database Network (GDN). |
| RemovePolarClawDevicePair | RemovePolarClawDevicePair | Unpairs a PolarClaw device. |
| RemovePolarClawMCPServer | RemovePolarClawMCPServer | Deletes a PolarClaw MCP server. |
| ResetAccount | ResetAccount | Resets the permissions of a privileged account for a PolarDB cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password for a PolarDB database account. |
| ResetAccountZonal | ResetAccountZonal | Resets an account in a PolarDB for Xscale cluster. |
| ResetGlobalDatabaseNetwork | ResetGlobalDatabaseNetwork | Resets the network of a secondary cluster in a Global Database Network (GDN). |
| RestartDBLink | RestartDBLink | Restarts database links. |
| RestartDBNode | RestartDBNode | Restarts a node of a PolarDB cluster. |
| RestartDBNodeZonal | RestartDBNodeZonal | Restarts a node of an edge cluster for PolarDB on ENS. |
| RestoreTable | RestoreTable | Restores databases or tables to a PolarDB cluster. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes access permissions on a database from a PolarDB standard account. |
| RevokeAccountPrivilegeZonal | RevokeAccountPrivilegeZonal | Revokes permissions from an account. |
| RunPolarClawCronJob | RunPolarClawCronJob | Runs a PolarClaw cron job. |
| SearchMemories | SearchMemories | Retrieves memories based on a search query. |
| SetPolarFsFileQuota | SetPolarFsFileQuota | Sets file quota rules for specific directories in a PolarFS instance. |
| SwitchOverGlobalDatabaseNetwork | SwitchOverGlobalDatabaseNetwork | Switches over the primary and secondary clusters in a global database network (GDN). |
| TagResources | TagResources | Adds tags to PolarDB clusters. |
| TempModifyDBNode | TempModifyDBNode | Temporarily Modifies the configuration of a node. |
| TransformDBClusterPayType | TransformDBClusterPayType | Changes the billing method of a PolarDB cluster. |
| UnbindPolarClawAgent | UnbindPolarClawAgent | Unbinds a PolarClaw Agent. |
| UninstallPolarClawPlugin | UninstallPolarClawPlugin | Uninstalls a PolarClaw plugin. |
| UntagResources | UntagResources | Detaches tags from a PolarDB cluster. |
| UpdateApplicationEnvironmentVariables | UpdateApplicationEnvironmentVariables | Updates the environment variables of an application. This operation is only supported for PolarClaw. |
| UpdateExtensions | UpdateExtensions | Updates one or more extensions. |
| UpdatePolarClawAgent | UpdatePolarClawAgent | Update PolarClaw Agent |
| UpdatePolarClawCronJob | UpdatePolarClawCronJob | Updates the configuration of a PolarClaw scheduled task, allowing for partial field updates. |
| UpgradeDBClusterVersion | UpgradeDBClusterVersion | Upgrades the kernel version of a PolarDB for MySQL cluster. |
| UpgradeDBClusterVersionZonal | UpgradeDBClusterVersionZonal | Upgrades the minor version of a PolarDB cluster. |
| UpgradePolarClawChannel | UpgradePolarClawChannel | Upgrades a PolarClaw channel. |
| UpgradePolarClawPlugin | UpgradePolarClawPlugin | Upgrades a PolarClaw plugin. |
| UpgradePolarClawSkills | UpgradePolarClawSkills | Upgrades the PolarClaw feature. |
该文章对您有帮助吗？