API standard and pre-built SDKs in multi-language
This product (adb/2019-03-15) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
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.
Cluster management
| API | Title | Description |
|---|---|---|
| CreateDBCluster | CreateDBCluster | Creates an AnalyticDB for MySQL Data Warehouse Edition cluster. |
| DeleteDBCluster | DeleteDBCluster | Deletes an AnalyticDB for MySQL cluster. |
| ModifyDBCluster | ModifyDBCluster | Changes the specifications of an AnalyticDB for MySQL cluster. |
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Changes the maintenance window of an AnalyticDB for MySQL cluster. |
| ModifyDBClusterPayType | ModifyDBClusterPayType | Changes the billing method of an AnalyticDB for MySQL cluster. |
| ModifyAutoRenewAttribute | ModifyAutoRenewAttribute | Modifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster. |
| ModifyDBClusterResourceGroup | ModifyDBClusterResourceGroup | Modifies the resource group of an AnalyticDB for MySQL cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries a list of AnalyticDB for MySQL clusters within a region. |
| DescribeDBClusterStatus | DescribeDBClusterStatus | Queries the status of AnalyticDB for MySQL Data Warehouse Edition clusters within a region. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries the information about an AnalyticDB for MySQL cluster. |
| DescribeAutoRenewAttribute | DescribeAutoRenewAttribute | Queries the auto-renewal status of a subscription AnalyticDB for MySQL cluster. |
| DescribeAvailableResource | DescribeAvailableResource | Queries the resources of clusters within zones of a region. |
| DescribeComputeResource | DescribeComputeResource | Queries the specifications of computing resources for AnalyticDB for MySQL Data Warehouse Edition clusters within a region. |
| DescribeEIURange | DescribeEIURange | Queries the range for the number of elastic I/O units (EIUs) for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
| AttachUserENI | AttachUserENI | |
| DetachUserENI | DetachUserENI | Detaches an elastic network interface (ENI) from an AnalyticDB for MySQL Data Warehouse Edition cluster. |
| DescribeKernelVersion | DescribeKernelVersion | Queries the information about the minor version of an AnalyticDB for MySQL cluster. |
| UpgradeKernelVersion | UpgradeKernelVersion | Updates the minor version of an AnalyticDB for MySQL cluster. |
| MigrateDBCluster | MigrateDBCluster | Migrates data from a Data Warehouse Edition cluster to a Data Lakehouse Edition or Enterprise Edition cluster in AnalyticDB for MySQL. |
Resource group management (old version)
| API | Title | Description |
|---|---|---|
| CreateDBResourcePool | CreateDBResourcePool | |
| DeleteDBResourcePool | DeleteDBResourcePool | Deletes a resource group. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition. |
| ModifyDBResourcePool | ModifyDBResourcePool | Modifies the resources of a resource group. This operation is available only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition. |
| DescribeDBResourcePool | DescribeDBResourcePool | Queries the information about resource groups of an AnalyticDB for MySQL cluster. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition. |
| BindDBResourcePoolWithUser | BindDBResourcePoolWithUser | Associates a resource group with a database account. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition. |
| UnbindDBResourcePoolWithUser | UnbindDBResourcePoolWithUser | Disassociates a database account from a resource group. This operation can be called only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition. |
Resource group management (new version)
| API | Title | Description |
|---|---|---|
| CreateDBResourceGroup | CreateDBResourceGroup | Creates a resource group for an AnalyticDB for MySQL cluster. |
| BindDBResourceGroupWithUser | BindDBResourceGroupWithUser | Associates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster with a database account. |
| UnbindDBResourceGroupWithUser | UnbindDBResourceGroupWithUser | Disassociates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster from a database account. |
| DescribeDBResourceGroup | DescribeDBResourceGroup | Queries the information about a resource group for an AnalyticDB for MySQL cluster. |
| ModifyDBResourceGroup | ModifyDBResourceGroup | Modifies the number of nodes or the query execution mode for a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
| DeleteDBResourceGroup | DeleteDBResourceGroup | Deletes a resource group from an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
| DescribeResubmitConfig | DescribeResubmitConfig | |
| ModifyResubmitConfig | ModifyResubmitConfig | |
| ModifySQAConfig | ModifySQAConfig | |
| DescribeSQAConfig | DescribeSQAConfig | Queries the short query acceleration (SQA) configuration of an AnalyticDB for MySQL cluster. |
Elastic plan management
| API | Title | Description |
|---|---|---|
| CreateElasticPlan | CreateElasticPlan | Creates a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition. |
| DeleteElasticPlan | DeleteElasticPlan | Deletes a scheduled scaling plan. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition. |
| ModifyElasticPlan | ModifyElasticPlan | Modifies a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition. |
| DescribeElasticDailyPlan | DescribeElasticDailyPlan | |
| DescribeElasticPlan | DescribeElasticPlan | Queries scaling plans of an AnalyticDB for MySQL cluster. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition. |
Database
| API | Title | Description |
|---|---|---|
| DescribeTables | DescribeTables | Queries a list of tables in a database of an AnalyticDB for MySQL cluster. |
| DescribeAllDataSource | DescribeAllDataSource | Queries a list of databases, tables, and columns in a cluster. |
| DescribeSchemas | DescribeSchemas | Queries a list of databases in an AnalyticDB for MySQL cluster. |
| DescribeTableDetail | DescribeTableDetail | Queries the distribution of data in a table among partitions. |
| DescribeProcessList | DescribeProcessList | Queries the queries that are being executed on a cluster. |
| DescribeColumns | DescribeColumns | Queries a list of columns in a table within an AnalyticDB for MySQL cluster. |
| DescribeTaskInfo | DescribeTaskInfo | Queries the information about a task. |
| DescribeSQLPlan | DescribeSQLPlan | Queries the plan information about an SQL statement such as a query statement or an extract-transform-load (ETL) task statement. |
| DescribeSQLPlanTask | DescribeSQLPlanTask | Queries the information about a task. |
| DescribeTablePartitionDiagnose | DescribeTablePartitionDiagnose | Queries the information about partition diagnostics. |
| DescribeLoadTasksRecords | DescribeLoadTasksRecords | Queries the information about asynchronous import and export tasks of an AnalyticDB for MySQL cluster. |
| DescribeConnectionCountRecords | DescribeConnectionCountRecords | Queries the current number of connections to an AnalyticDB for MySQL cluster. |
| KillProcess | KillProcess | Terminates an ongoing query. |
Log management
| API | Title | Description |
|---|---|---|
| ModifyAuditLogConfig | ModifyAuditLogConfig | |
| DescribeSlowLogRecords | DescribeSlowLogRecords | |
| DescribeAuditLogConfig | DescribeAuditLogConfig | Queries the SQL audit settings of an AnalyticDB for MySQL cluster. |
| DescribeAuditLogRecords | DescribeAuditLogRecords | Queries the SQL audit logs of an AnalyticDB for MySQL cluster. |
Region management
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries a list of available regions and zones for AnalyticDB for MySQL. |
Network management
| API | Title | Description |
|---|---|---|
| ModifyClusterConnectionString | ModifyClusterConnectionString | Changes the endpoint of an AnalyticDB for MySQL cluster. |
| DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | Queries the network information about an AnalyticDB for MySQL cluster. |
| AllocateClusterPublicConnection | AllocateClusterPublicConnection | Applies for a public endpoint for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
| ReleaseClusterPublicConnection | ReleaseClusterPublicConnection | Releases the public endpoint of an AnalyticDB for MySQL cluster. |
| DescribeVSwitches | DescribeVSwitches | Queries the vSwitches. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates a database account for an AnalyticDB for MySQL cluster. |
| DeleteAccount | DeleteAccount | |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account for an AnalyticDB for MySQL cluster. |
| DescribeAllAccounts | DescribeAllAccounts | Queries the information about an account or the list of accounts of a specific database within an AnalyticDB for MySQL cluster. |
| DescribeAccounts | DescribeAccounts | Queries a list of database accounts for an AnalyticDB for MySQL cluster. |
| DescribeOperatorPermission | DescribeOperatorPermission | Queries the details of the permissions granted to the service account of an AnalyticDB for MySQL cluster. |
| GrantOperatorPermission | GrantOperatorPermission | Grants permissions to the service account of an AnalyticDB for MySQL cluster. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account for an AnalyticDB for MySQL cluster. |
| RevokeOperatorPermission | RevokeOperatorPermission | Revokes permissions from the service account of an AnalyticDB for MySQL cluster. |
Tag management
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added. |
| TagResources | TagResources | Adds tags to an AnalyticDB for MySQL cluster. |
| UntagResources | UntagResources | Removes all tags from AnalyticDB for MySQL clusters. |
Security management
| API | Title | Description |
|---|---|---|
| ModifyDBClusterAccessWhiteList | ModifyDBClusterAccessWhiteList | Modifies the IP address whitelists of a cluster. |
| DescribeDBClusterAccessWhiteList | DescribeDBClusterAccessWhiteList | Queries a list of IP address whitelists for an AnalyticDB for MySQL cluster. |
| DescribeDBClusterSSL | DescribeDBClusterSSL | Queries the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
| ModifyDBClusterSSL | ModifyDBClusterSSL | Modifies the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
Others
| API | Title | Description |
|---|---|---|
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup policy of an AnalyticDB for MySQL cluster. |
| ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup settings of an AnalyticDB for MySQL cluster. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup settings of an AnalyticDB for MySQL cluster. |
| DescribeBackups | DescribeBackups | Queries a list of backup sets for an AnalyticDB for MySQL cluster. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeDBClusterHealthStatus | DescribeDBClusterHealthStatus | Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of an AnalyticDB for MySQL cluster. |
| DescribeDBClusterResourcePoolPerformance | DescribeDBClusterResourcePoolPerformance | Queries the monitoring information about resource groups within an AnalyticDB for MySQL cluster. |
| DescribeInclinedTables | DescribeInclinedTables | Queries the information about skewed tables for an AnalyticDB for MySQL cluster. |
O\&M management
| API | Title | Description |
|---|---|---|
| ModifyMaintenanceAction | ModifyMaintenanceAction | Changes the switchover time of O\&M events. |
| DescribeMaintenanceAction | DescribeMaintenanceAction | Queries the information about O\&M events. |
SQL diagnostics
| API | Title | Description |
|---|---|---|
| DescribeDiagnosisTasks | DescribeDiagnosisTasks | Queries the execution information about distributed tasks in a stage of a query. |
| DescribeDiagnosisRecords | DescribeDiagnosisRecords | Queries the diagnostic information about SQL statements that meet a condition in an AnalyticDB for MySQL cluster. |
| DescribeDiagnosisDimensions | DescribeDiagnosisDimensions | Queries the deduplicated statistics of SQL statements that meet a condition of the resource group, database, username, and source IP address in an AnalyticDB for MySQL cluster. |
| DescribeDownloadRecords | DescribeDownloadRecords | Queries a list of download tasks for the last five SQL queries of an AnalyticDB for MySQL cluster. |
| DownloadDiagnosisRecords | DownloadDiagnosisRecords | Downloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL cluster. |
| DescribeDiagnosisSQLInfo | DescribeDiagnosisSQLInfo | Queries the execution information about an SQL statement, including the execution plan, execution information, resource usage, and self-diagnostics results. |
| DescribeDiagnosisMonitorPerformance | DescribeDiagnosisMonitorPerformance | Queries the monitoring information about queries within a time range. |
| DescribeSQLPatterns | DescribeSQLPatterns | Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a period of time. |
| DescribePatternPerformance | DescribePatternPerformance | Queries the metrics of an SQL pattern such as the query duration and average memory usage within a period of time. |
| EnableAdviceService | EnableAdviceService | Enables the suggestion feature. |
| ApplyAdviceById | ApplyAdviceById | Applies an optimization suggestion. |
| BatchApplyAdviceByIdList | BatchApplyAdviceByIdList | Applies multiple optimization suggestions at a time. |
| DescribeAdviceServiceEnabled | DescribeAdviceServiceEnabled | Queries whether the suggestion feature is enabled for an AnalyticDB for MySQL cluster. |
| DescribeAppliedAdvices | DescribeAppliedAdvices | Queries the applied optimization suggestions for an AnalyticDB for MySQL cluster. |
| DescribeAvailableAdvices | DescribeAvailableAdvices | Queries the available suggestions for cluster optimization. |
| DisableAdviceService | DisableAdviceService | Disables the suggestion feature. |
Storage analysis
| API | Title | Description |
|---|---|---|
| DescribeDBClusterSpaceSummary | DescribeDBClusterSpaceSummary | Queries the storage overview information of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster, such as the total data size, hot data size, cold data size, and data growth. |
| DescribeTableStatistics | DescribeTableStatistics | Queries the information about table statistics for an AnalyticDB for MySQL cluster. |
| DescribeExcessivePrimaryKeys | DescribeExcessivePrimaryKeys | Queries the tables that have excessive primary key fields in an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. |
Cluster running reports
| API | Title | Description |
|---|---|---|
| DescribeTableAccessCount | DescribeTableAccessCount | |
| DescribeSqlPattern | DescribeSqlPattern | Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a time range. |
Others
| API | Title | Description |
|---|---|---|
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role is created. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Creates a service-linked role. |
| DescribeKmsKeys | DescribeKmsKeys | Queries a list of Key Management Service (KMS) keys. |
| DescribeLogHubAttribute | DescribeLogHubAttribute | Queries the information about a log shipping job. |
| DescribeLogStoreKeys | DescribeLogStoreKeys | Queries a list of log keywords in a Logstore. |
| DescribeLoghubDetail | DescribeLoghubDetail | Queries the log collection information. |
| DescribeRdsAnalysisResourceQuotas | DescribeRdsAnalysisResourceQuotas | Queries the information about specifications of MySQL analytic instances. |
| DescribeRegionsMixed | DescribeRegionsMixed | Queries information about regions. |
| DescribeSyncAvailableDBClusterList | DescribeSyncAvailableDBClusterList | Queries a list of instances or clusters that are available for data synchronization. |
| DescribeSyncJobList | DescribeSyncJobList | Queries a list of synchronization jobs in an AnalyticDB for MySQL cluster. |
| DescribeVSwitchs | DescribeVSwitchs | Queries a list of available vSwitches. |
| DescribeVpcs | DescribeVpcs | Queries a list of available virtual private clouds (VPCs). |
| ModifyLogHubStatus | ModifyLogHubStatus | Changes the status of a log shipping job. |
| ModifySyncJob | ModifySyncJob | Modifies the synchronization jobs for an AnalyticDB for MySQL cluster. |
| OperateLogHub | OperateLogHub | |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events. |
| DescribeHistoryEventsStat | DescribeHistoryEventsStat | Queries the information about historical events in the event center. |
| ModifyActiveOperationMaintainConf | ModifyActiveOperationMaintainConf | Changes the time configuration of O\\\&M events. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the information about O\&M tasks. |
| DescribeActiveOperationMaintainConf | DescribeActiveOperationMaintainConf | Queries the configuration information about O\\\&M tasks. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Changes the execution time of O\&M events. |
| DescribeControllerDetection | DescribeControllerDetection | Queries the diagnostic results of the access layer. |
| DescribeWorkerDetection | DescribeWorkerDetection | Queries the diagnostic results of the storage layer. |
| DescribeAbnormalPatternDetection | DescribeAbnormalPatternDetection | Queries abnormal SQL patterns within a time range. |
| DescribeBadSqlDetection | DescribeBadSqlDetection | Queries the bad SQL statements that affect cluster stability within a time range. |
| DescribeExecutorDetection | DescribeExecutorDetection | Queries the diagnostic results of the compute layer. |
| ModifyDBClusterVip | ModifyDBClusterVip | Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster. |
| GetCreateTableSQL | GetCreateTableSQL | Queries the table creation statement for tables. |
| DescribeInclinedNodes | DescribeInclinedNodes | Queries the disk usage of all storage nodes. |
| DescribeOversizeNonPartitionTableInfos | DescribeOversizeNonPartitionTableInfos | Queries the information about oversized non-partitioned tables in an AnalyticDB for MySQL cluster. |
| ModifyDBClusterShardNumber | ModifyDBClusterShardNumber | Changes the number of shards for an AnalyticDB for MySQL cluster. |
| DeleteBackups | DeleteBackups | Manually deletes backup sets. |
| DescribeDBClusterShardNumber | DescribeDBClusterShardNumber | Queries the number of shards in an AnalyticDB for MySQL cluster. |