API overview-AnalyticDB(AnalyticDB)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (adb/2019-03-15) 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.

Cluster management

API	Title	Description
ModifyDBClusterPayType	ModifyDBClusterPayType	Changes the billing method of an AnalyticDB for MySQL cluster.
DescribeEIURange	DescribeEIURange	You can call the DescribeEIURange operation to query the range of elastic I/O units (EIUs) available for a Data Lakehouse Edition cluster.
AttachUserENI	AttachUserENI	Creates an Elastic Network Interface (ENI) in a VPC for a Data Warehouse Edition cluster to enable network access from AnalyticDB for MySQL nodes to your VPC.
MigrateDBCluster	MigrateDBCluster	Migrates a Data Warehouse Edition cluster to a Data Lakehouse Edition or an Enterprise Edition cluster.

Resource group management (old version)

API	Title	Description
CreateDBResourcePool	CreateDBResourcePool	You can call the CreateDBResourcePool operation to create a resource group. This operation applies only to AnalyticDB for MySQL clusters of the new version in elastic mode.
BindDBResourcePoolWithUser	BindDBResourcePoolWithUser	Call the BindDBResourcePoolWithUser operation to attach a resource group to a database account.
UnbindDBResourcePoolWithUser	UnbindDBResourcePoolWithUser	The UnbindDBResourcePoolWithUser operation detaches a database account from a resource group. This operation applies only to Data Warehouse Edition (V3.0) clusters in elastic mode.

Resource group management (new version)

API	Title	Description
CreateDBResourceGroup	CreateDBResourceGroup	Creates a resource group for a cluster.
BindDBResourceGroupWithUser	BindDBResourceGroupWithUser	The BindDBResourceGroupWithUser operation attaches a database account to a resource group in a Data Warehouse Edition (V3.0) cluster.
UnbindDBResourceGroupWithUser	UnbindDBResourceGroupWithUser	Call the UnbindDBResourceGroupWithUser operation to detach a database account from a resource group in a Data Warehouse Edition cluster.
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.
DescribeResubmitConfig	DescribeResubmitConfig	Query resubmission configuration
ModifyResubmitConfig	ModifyResubmitConfig	Modifies the Resubmit configuration.
ModifySQAConfig	ModifySQAConfig	Modifies the Short Query Acceleration (SQA) configuration.
DescribeSQAConfig	DescribeSQAConfig	Call the DescribeSQAConfig operation to query the Short Query Acceleration (SQA) configuration for a cluster.

Elastic Plan Management

API	Title	Description
DescribeElasticDailyPlan	DescribeElasticDailyPlan	You can call DescribeElasticDailyPlan to query the execution information of a daily time-based scaling plan. This operation applies only to new-version Data Warehouse Edition clusters in elastic mode.

Database

API	Title	Description
DescribeTableDetail	DescribeTableDetail	Queries the distribution of data in a table among partitions.
DescribeLoadTasksRecords	DescribeLoadTasksRecords	Retrieves the details of asynchronous import and export tasks.
DescribeConnectionCountRecords	DescribeConnectionCountRecords	Queries the number of connections to an AnalyticDB for MySQL cluster.

Log management

API	Title	Description
ModifyAuditLogConfig	ModifyAuditLogConfig	You can call the ModifyAuditLogConfig operation to modify the audit log settings.
DescribeSlowLogRecords	DescribeSlowLogRecords	Queries the details of slow query logs for an AnalyticDB for MySQL cluster.

Network management

API	Title	Description
AllocateClusterPublicConnection	AllocateClusterPublicConnection	Applies for a public endpoint for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Account management

API	Title	Description
CreateAccount	CreateAccount	You can call the CreateAccount operation to create an account.
DeleteAccount	DeleteAccount	The DeleteAccount operation deletes a database account.
DescribeAccounts	DescribeAccounts	Queries the details of accounts in a cluster.

Others

API	Title	Description
DescribeBackups	DescribeBackups	Lists backups for an AnalyticDB for MySQL cluster.
ApplyAdviceById	ApplyAdviceById	Calls the ApplyAdviceById operation to apply an optimization suggestion.
BatchApplyAdviceByIdList	BatchApplyAdviceByIdList	Use the BatchApplyAdviceByIdList API to batch apply one or more optimization suggestions.
CancelActiveOperationTasks	CancelActiveOperationTasks	Cancels O\\\&M events.
CheckServiceLinkedRole	CheckServiceLinkedRole	Checks whether a service-linked role is created.
CreateDBCluster	CreateDBCluster	Creates an AnalyticDB for MySQL Data Warehouse Edition cluster.
CreateElasticPlan	CreateElasticPlan	Creates a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
CreateServiceLinkedRole	CreateServiceLinkedRole	Creates a service-linked role.
DeleteBackups	DeleteBackups	Manually deletes backup sets.
DeleteDBCluster	DeleteDBCluster	Deletes an AnalyticDB for MySQL cluster.
DeleteDBResourceGroup	DeleteDBResourceGroup	Deletes a resource group from an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
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.
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.
DescribeAbnormalPatternDetection	DescribeAbnormalPatternDetection	Queries abnormal SQL patterns within a time range.
DescribeActiveOperationMaintainConf	DescribeActiveOperationMaintainConf	Queries the configuration information about O\\\&M tasks.
DescribeActiveOperationTasks	DescribeActiveOperationTasks	Queries the information about O\&M tasks.
DescribeAdviceServiceEnabled	DescribeAdviceServiceEnabled	Queries whether the suggestion feature is enabled 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.
DescribeAllDataSource	DescribeAllDataSource	Queries a list of databases, tables, and columns in a cluster.
DescribeAppliedAdvices	DescribeAppliedAdvices	Call the DescribeAppliedAdvices operation to list applied optimization suggestions.
DescribeAuditLogConfig	DescribeAuditLogConfig	Queries the SQL audit settings of an AnalyticDB for MySQL cluster.
DescribeAuditLogRecords	DescribeAuditLogRecords	Call the DescribeAuditLogRecords operation to query the SQL audit logs of a Data Warehouse Edition cluster.
DescribeAutoRenewAttribute	DescribeAutoRenewAttribute	Queries the auto-renewal status of a subscription AnalyticDB for MySQL cluster.
DescribeAvailableAdvices	DescribeAvailableAdvices	The DescribeAvailableAdvices operation lists available optimization suggestions.
DescribeAvailableResource	DescribeAvailableResource	Queries the resources of clusters within zones of a region.
DescribeBackupPolicy	DescribeBackupPolicy	Queries the backup settings of an AnalyticDB for MySQL cluster.
DescribeBadSqlDetection	DescribeBadSqlDetection	Queries the bad SQL statements that affect cluster stability within a time range.
DescribeColumns	DescribeColumns	Queries a list of columns in a table within an AnalyticDB for MySQL cluster.
DescribeComputeResource	DescribeComputeResource	Queries the specifications of computing resources for AnalyticDB for MySQL Data Warehouse Edition clusters within a region.
DescribeControllerDetection	DescribeControllerDetection	Queries the diagnostic results of the access layer.
DescribeDBClusterAccessWhiteList	DescribeDBClusterAccessWhiteList	Queries a list of IP address whitelists for an AnalyticDB for MySQL cluster.
DescribeDBClusterAttribute	DescribeDBClusterAttribute	You can call the DescribeDBClusterAttribute operation to view the details of a specified AnalyticDB for MySQL cluster.
DescribeDBClusterHealthStatus	DescribeDBClusterHealthStatus	Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition cluster.
DescribeDBClusterNetInfo	DescribeDBClusterNetInfo	Call the DescribeDBClusterNetInfo API to retrieve network information about an ADB 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.
DescribeDBClusterSSL	DescribeDBClusterSSL	Queries the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
DescribeDBClusterShardNumber	DescribeDBClusterShardNumber	Queries the number of shards in an AnalyticDB for MySQL cluster.
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.
DescribeDBClusterStatus	DescribeDBClusterStatus	Queries the status of AnalyticDB for MySQL Data Warehouse Edition clusters within a region.
DescribeDBClusters	DescribeDBClusters	List Data Lakehouse Edition clusters.
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.
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.
DescribeDiagnosisMonitorPerformance	DescribeDiagnosisMonitorPerformance	Queries the monitoring information about queries within a time range.
DescribeDiagnosisRecords	DescribeDiagnosisRecords	Queries the diagnostic information about SQL statements that meet a condition in 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.
DescribeDiagnosisTasks	DescribeDiagnosisTasks	Queries the execution information about distributed tasks in a stage of a query.
DescribeDownloadRecords	DescribeDownloadRecords	Queries a list of download tasks for the last five SQL queries of an AnalyticDB for MySQL cluster.
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.
DescribeExcessivePrimaryKeys	DescribeExcessivePrimaryKeys	Queries the tables that have excessive primary key fields in an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
DescribeExecutorDetection	DescribeExecutorDetection	Queries the diagnostic results of the compute layer.
DescribeHistoryEventsStat	DescribeHistoryEventsStat	Queries the information about historical events in the event center.
DescribeInclinedNodes	DescribeInclinedNodes	Queries the disk usage of all storage nodes.
DescribeInclinedTables	DescribeInclinedTables	Queries the information about skewed tables for an AnalyticDB for MySQL cluster.
DescribeKernelVersion	DescribeKernelVersion	Queries the information about the minor version of an AnalyticDB for MySQL cluster.
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.
DescribeMaintenanceAction	DescribeMaintenanceAction	Queries the information about O\&M events.
DescribeOperatorPermission	DescribeOperatorPermission	Queries the details of the permissions granted to the service account of an AnalyticDB for MySQL cluster.
DescribeOversizeNonPartitionTableInfos	DescribeOversizeNonPartitionTableInfos	Queries the information about oversized non-partitioned tables in an AnalyticDB for MySQL cluster.
DescribePatternPerformance	DescribePatternPerformance	Queries the metrics of an SQL pattern such as the query duration and average memory usage within a period of time.
DescribeProcessList	DescribeProcessList	Queries the queries that are being executed on a cluster.
DescribeRdsAnalysisResourceQuotas	DescribeRdsAnalysisResourceQuotas	Queries the information about specifications of MySQL analytic instances.
DescribeRegions	DescribeRegions	Queries a list of available regions and zones for AnalyticDB for MySQL.
DescribeRegionsMixed	DescribeRegionsMixed	Queries information about regions.
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.
DescribeSchemas	DescribeSchemas	Queries a list of databases in an AnalyticDB for MySQL cluster.
DescribeSqlPattern	DescribeSqlPattern	Queries a list of SQL patterns for an AnalyticDB for MySQL cluster within a time range.
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.
DescribeTablePartitionDiagnose	DescribeTablePartitionDiagnose	Queries the information about partition diagnostics.
DescribeTables	DescribeTables	Queries a list of tables in a database of an AnalyticDB for MySQL cluster.
DescribeTaskInfo	DescribeTaskInfo	Queries the information about a task.
DescribeVSwitches	DescribeVSwitches	Queries the vSwitches.
DescribeVSwitchs	DescribeVSwitchs	Queries a list of available vSwitches.
DescribeVpcs	DescribeVpcs	Queries a list of available virtual private clouds (VPCs).
DescribeWorkerDetection	DescribeWorkerDetection	Queries the diagnostic results of the storage layer.
DetachUserENI	DetachUserENI	Detaches an elastic network interface (ENI) from an AnalyticDB for MySQL Data Warehouse Edition cluster.
DisableAdviceService	DisableAdviceService	Disables the suggestion feature.
DownloadDiagnosisRecords	DownloadDiagnosisRecords	Downloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL cluster.
EnableAdviceService	EnableAdviceService	Enables the suggestion feature.
GetCreateTableSQL	GetCreateTableSQL	Queries the table creation statement for tables.
GrantOperatorPermission	GrantOperatorPermission	Grants permissions to the service account of an AnalyticDB for MySQL cluster.
KillProcess	KillProcess	Terminates an ongoing query.
ListTagResources	ListTagResources	Queries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added.
ModifyAccountDescription	ModifyAccountDescription	Modifies the description of a database account for an AnalyticDB for MySQL cluster.
ModifyActiveOperationMaintainConf	ModifyActiveOperationMaintainConf	Changes the time configuration of O\\\&M events.
ModifyActiveOperationTasks	ModifyActiveOperationTasks	Changes the execution time of O\&M events.
ModifyAutoRenewAttribute	ModifyAutoRenewAttribute	Modifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster.
ModifyBackupPolicy	ModifyBackupPolicy	Modifies the backup policy of an AnalyticDB for MySQL cluster.
ModifyClusterConnectionString	ModifyClusterConnectionString	Changes the endpoint of an AnalyticDB for MySQL cluster.
ModifyDBCluster	ModifyDBCluster	Changes the specifications of an AnalyticDB for MySQL cluster.
ModifyDBClusterAccessWhiteList	ModifyDBClusterAccessWhiteList	Modifies the IP address whitelists of a cluster.
ModifyDBClusterDescription	ModifyDBClusterDescription	Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster.
ModifyDBClusterMaintainTime	ModifyDBClusterMaintainTime	Changes the maintenance window of an AnalyticDB for MySQL cluster.
ModifyDBClusterResourceGroup	ModifyDBClusterResourceGroup	Modifies the resource group of an AnalyticDB for MySQL cluster.
ModifyDBClusterSSL	ModifyDBClusterSSL	Modifies the SSL configurations of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
ModifyDBClusterShardNumber	ModifyDBClusterShardNumber	Changes the number of shards for an AnalyticDB for MySQL cluster.
ModifyDBClusterVip	ModifyDBClusterVip	Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.
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.
ModifyElasticPlan	ModifyElasticPlan	Modifies a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
ModifyLogBackupPolicy	ModifyLogBackupPolicy	Modifies the log backup settings of an AnalyticDB for MySQL cluster.
ModifyLogHubStatus	ModifyLogHubStatus	Changes the status of a log shipping job.
ModifyMaintenanceAction	ModifyMaintenanceAction	Changes the switchover time of O\&M events.
ModifySyncJob	ModifySyncJob	Modifies the synchronization jobs for an AnalyticDB for MySQL cluster.
OperateLogHub	OperateLogHub	Modifies a LogHub delivery rule.
ReleaseClusterPublicConnection	ReleaseClusterPublicConnection	Releases the public endpoint 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.
TagResources	TagResources	Adds tags to an AnalyticDB for MySQL cluster.
UntagResources	UntagResources	Removes all tags from AnalyticDB for MySQL clusters.
UpgradeKernelVersion	UpgradeKernelVersion	Updates the minor version of an AnalyticDB for MySQL cluster.

SQL diagnostics

API	Title	Description
DescribeSQLPatterns	DescribeSQLPatterns	You can call the DescribeSQLPatterns operation to view a list of SQL patterns for an AnalyticDB for MySQL cluster on a specified date.

Storage analysis

API	Title	Description
DescribeTableStatistics	DescribeTableStatistics	Retrieves table statistics from a specified AnalyticDB for MySQL cluster.

Cluster running reports

API	Title	Description
DescribeTableAccessCount	DescribeTableAccessCount	Queries the access count for a specific table or all tables in an AnalyticDB for MySQL cluster on a specified date.