Promo Center

50% off for new user

Direct Mail-46% off

Learn More

List of operations by function

Updated at: 2025-01-03 04:15
This product(adb/2021-12-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Region management

APITitleDescription
APITitleDescription
DescribeRegionsDescribeRegionsQueries a list of regions and zones in which AnalyticDB for MySQL Data Lakehouse Edition (V3.0) is available.

Cluster management

APITitleDescription
APITitleDescription
CreateDBClusterCreateDBClusterCreates an AnalyticDB for MySQL Data Lakehouse Edition cluster.
ModifyDBClusterModifyDBClusterChanges the configurations of an AnalyticDB for MySQL Data Lakehouse Edition cluster.
DescribeDBClustersDescribeDBClustersQueries the information about AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.
DescribeDBClusterStatusDescribeDBClusterStatusQueries the statuses of AnalyticDB for MySQL clusters within a region.
DescribeDBClusterAttributeDescribeDBClusterAttributeQueries the information about an AnalyticDB for MySQL cluster.
DeleteDBClusterDeleteDBClusterDeletes an AnalyticDB for MySQL cluster.
ModifyDBClusterDescriptionModifyDBClusterDescriptionModifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster.
DescribeClusterNetInfoDescribeClusterNetInfoQueries the network information about an AnalyticDB for MySQL cluster.
AllocateClusterPublicConnectionAllocateClusterPublicConnectionApplies for a public endpoint for an AnalyticDB for MySQL cluster.
ReleaseClusterPublicConnectionReleaseClusterPublicConnectionReleases the public endpoint of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
ModifyClusterConnectionStringModifyClusterConnectionStringModifies the public endpoint of an AnalyticDB for MySQL cluster.
DescribeClusterAccessWhiteListDescribeClusterAccessWhiteListQueries the IP address whitelists of an AnalyticDB for MySQL cluster.
ModifyClusterAccessWhiteListModifyClusterAccessWhiteListModifies the IP address whitelist of an AnalyticDB for MySQL cluster.

Resource group management

APITitleDescription
APITitleDescription
CreateDBResourceGroupCreateDBResourceGroupCreates a resource group for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
DescribeDBResourceGroupDescribeDBResourceGroupQueries the information about resource groups of an AnalyticDB for MySQL cluster.
ModifyDBResourceGroupModifyDBResourceGroupModifies the amount of reserved computing resources for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
DeleteDBResourceGroupDeleteDBResourceGroupDeletes a resource group from an AnalyticDB for MySQL cluster.
BindDBResourceGroupWithUserBindDBResourceGroupWithUserAssociates a resource group with a database account.
UnbindDBResourceGroupWithUserUnbindDBResourceGroupWithUserDisassociates resource groups from database accounts for an AnalyticDB for MySQL cluster.
DescribeApsResourceGroupsDescribeApsResourceGroupsQueries the information about resource groups of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
DescribeComputeResourceUsageDescribeComputeResourceUsageQueries the computing resource usage of a resource group in an AnalyticDB for MySQL cluster.
DescribeUserQuotaDescribeUserQuotaQueries available quotas.

Elastic Plan Management

APITitleDescription
APITitleDescription
CreateElasticPlanCreateElasticPlanCreates a scaling plan for an AnalyticDB for MySQL cluster.
DescribeElasticPlansDescribeElasticPlansQueries scaling plans of an AnalyticDB for MySQL cluster.
ModifyElasticPlanModifyElasticPlanModifies a scaling plan for an AnalyticDB for MySQL cluster.
EnableElasticPlanEnableElasticPlanEnables a scaling plan for an AnalyticDB for MySQL cluster.
DisableElasticPlanDisableElasticPlanDisables a scaling plan for an AnalyticDB for MySQL cluster.
DeleteElasticPlanDeleteElasticPlanDeletes a scaling plan from an AnalyticDB for MySQL cluster.
DescribeElasticPlanJobsDescribeElasticPlanJobsQueries a list of scaling plan jobs for an AnalyticDB for MySQL cluster.
DescribeElasticPlanAttributeDescribeElasticPlanAttributeQueries the information about a scaling plan for an AnalyticDB for MySQL cluster.
DescribeElasticPlanSpecificationsDescribeElasticPlanSpecificationsQueries the resource specifications that are supported by different types of scaling plans of an AnalyticDB for MySQL cluster.

Log management

APITitleDescription
APITitleDescription
DescribeAuditLogRecordsDescribeAuditLogRecordsQueries the SQL audit logs of an AnalyticDB for MySQL cluster.
ModifyAuditLogConfigModifyAuditLogConfigModifies the SQL audit settings of an AnalyticDB for MySQL cluster.

APITitleDescription
APITitleDescription
AttachUserENIAttachUserENIAttaches an elastic network interface (ENI) to an AnalyticDB for MySQL cluster.
DetachUserENIDetachUserENI

Account management

APITitleDescription
APITitleDescription
CreateAccountCreateAccountCreates a database account for an AnalyticDB for MySQL cluster.
DescribeAccountsDescribeAccountsQueries the database accounts of an AnalyticDB for MySQL cluster.
BindAccountBindAccountAssociates a standard account of an AnalyticDB for MySQL cluster with a Resource Access Management (RAM) user.
UnbindAccountUnbindAccountDisassociates a standard account of an AnalyticDB for MySQL cluster from a Resource Access Management (RAM) user.
CheckBindRamUserCheckBindRamUserQueries whether a database account of an AnalyticDB for MySQL cluster is associated with a Resource Access Management (RAM) user.
ResetAccountPasswordResetAccountPasswordResets the password of a database account for an AnalyticDB for MySQL cluster.
ModifyAccountDescriptionModifyAccountDescriptionModifies the description of a database account for an AnalyticDB for MySQL cluster.
DeleteAccountDeleteAccountDeletes a database account from an AnalyticDB for MySQL cluster.
ModifyAccountPrivilegesModifyAccountPrivilegesModifies the permissions of a database account.
DescribeAccountPrivilegesDescribeAccountPrivilegesQueries the permissions of a database account on a specified permission level.
DescribeEnabledPrivilegesDescribeEnabledPrivilegesQueries the permission level and permissions supported for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
DescribeAccountAllPrivilegesDescribeAccountAllPrivilegesQueries the permissions of a database account on all permission levels.
DescribeAccountPrivilegeObjectsDescribeAccountPrivilegeObjectsQueries the databases, tables, and columns on which a database account has permissions.

APITitleDescription
APITitleDescription
DescribeBackupsDescribeBackups
DescribeBackupPolicyDescribeBackupPolicy
ModifyBackupPolicyModifyBackupPolicyModifies the backup policy of an AnalyticDB for MySQL cluster.

Monitoring management

APITitleDescription
APITitleDescription
DescribeDBClusterHealthStatusDescribeDBClusterHealthStatusQueries the health status of an AnalyticDB for MySQL cluster.
DescribeDBClusterPerformanceDescribeDBClusterPerformanceQueries the performance data of an AnalyticDB for MySQL cluster.
DescribeClusterResourceUsageDescribeClusterResourceUsageQueries the resource usage of an AnalyticDB for MySQL cluster.
DescribeClusterResourceDetailDescribeClusterResourceDetailQueries the information about resource usage of an AnalyticDB for MySQL cluster.
DescribeStorageResourceUsageDescribeStorageResourceUsageQueries the storage resource usage of an AnalyticDB for MySQL cluster.
DescribeJobResourceUsageDescribeJobResourceUsage
DescribePerformanceViewsDescribePerformanceViewsQueries a list of monitoring views.
CreatePerformanceViewCreatePerformanceViewCreates a custom monitoring view.
ModifyPerformanceViewModifyPerformanceViewModifies the information about a custom monitoring view.
DescribePerformanceViewAttributeDescribePerformanceViewAttributeQueries the information about a monitoring view.
DeletePerformanceViewDeletePerformanceViewDeletes a monitoring view.
ExistRunningSQLEngineExistRunningSQLEngineQueries whether a running SQL engine exists.

Spark development

APITitleDescription
APITitleDescription
PreloadSparkAppMetricsPreloadSparkAppMetricsPreloads metrics for a Spark application.
GetSparkAppMetricsGetSparkAppMetricsQueries the metrics of a Spark application.
ListSparkLogAnalyzeTasksListSparkLogAnalyzeTasksQueries a list of Spark log analysis tasks.
SubmitSparkLogAnalyzeTaskSubmitSparkLogAnalyzeTaskSubmits a Spark log analysis task and queries the analysis results.
KillSparkLogAnalyzeTaskKillSparkLogAnalyzeTaskTerminates a Spark log analysis task and queries the information about the analysis task.
GetSparkLogAnalyzeTaskGetSparkLogAnalyzeTaskQueries the results of a Spark log analysis task.
SetSparkAppLogRootPathSetSparkAppLogRootPathModifies the Spark log configuration.
GetSparkConfigLogPathGetSparkConfigLogPathQueries the Spark log configuration of an AnalyticDB for MySQL cluster, including the default Spark log path.
StartSparkSQLEngineStartSparkSQLEngineStarts the Spark SQL engine.
KillSparkSQLEngineKillSparkSQLEngineShuts down a Spark SQL engine.
GetSparkSQLEngineStateGetSparkSQLEngineStateQueries the state information about the Spark SQL engine.
ListSparkTemplateFileIdsListSparkTemplateFileIdsQueries a list of Spark template file IDs for AnalyticDB for MySQL clusters.
GetSparkAppWebUiAddressGetSparkAppWebUiAddressQueries the URL of the web UI for a Spark application.
ListSparkAppAttemptsListSparkAppAttemptsQueries the information about retry attempts of a Spark application.
CreateSparkTemplateCreateSparkTemplateCreates a Spark application template.
DeleteSparkTemplateDeleteSparkTemplateDeletes Spark template files.
GetSparkTemplateFolderTreeGetSparkTemplateFolderTreeQueries the directory structure of Spark applications.
GetSparkTemplateFullTreeGetSparkTemplateFullTreeQueries the directory structure of Spark applications.
GetSparkTemplateFileContentGetSparkTemplateFileContentQueries the content of a Spark application template.
UpdateSparkTemplateFileUpdateSparkTemplateFileUpdates a Spark application template.
DeleteSparkTemplateFileDeleteSparkTemplateFileDeletes Spark template files.
GetSparkAppAttemptLogGetSparkAppAttemptLogQueries the information about the retry log of a Spark application.
ListSparkAppsListSparkAppsQueries the Spark applications that run on an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
GetSparkAppInfoGetSparkAppInfoQueries the information about an Spark application.
GetSparkAppStateGetSparkAppStateQueries the status of a Spark application.
GetSparkAppLogGetSparkAppLogQueries the logs of a Spark application.
SubmitSparkAppSubmitSparkAppSubmits a Spark application.
KillSparkAppKillSparkAppTerminates a Spark application.

Database management

APITitleDescription
APITitleDescription
DescribeAdbMySqlColumnsDescribeAdbMySqlColumnsQueries the information about table columns for an AnalyticDB for MySQL cluster.
DescribeAdbMySqlTablesDescribeAdbMySqlTablesQueries a list of tables for an AnalyticDB for MySQL cluster.
DescribeAdbMySqlSchemasDescribeAdbMySqlSchemasQueries a list of databases for an AnalyticDB for MySQL cluster.
GetViewDDLGetViewDDLQueries the statement that is used to create a view.
GetViewObjectsGetViewObjectsQueries the information about views.
GetDatabaseObjectsGetDatabaseObjectsQueries the information about databases.
GetTableGetTableQueries the information about a table.
GetTableColumnsGetTableColumnsQueries the information about columns.
GetTableDDLGetTableDDLQueries the statement that is used to create a table.
GetTableObjectsGetTableObjectsQuery the details of one or more tables.
CheckSampleDataSetCheckSampleDataSet
DescribeSchemasDescribeSchemasQueries a list of databases in an AnalyticDB for MySQL cluster.
DescribeAllDataSourceDescribeAllDataSourceQueries a list of databases, tables, and columns in an AnalyticDB for MySQL cluster.
DescribeTablesDescribeTablesQueries a list of tables in a database.
DescribeColumnsDescribeColumnsQueries a list of columns in a table.
LoadSampleDataSetLoadSampleDataSetLoads a built-in dataset.

SQL diagnostics

APITitleDescription
APITitleDescription
DescribeSqlPatternDescribeSqlPatternQueries the information about SQL patterns of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range.
DescribeSQLPatternsDescribeSQLPatternsQueries a list of SQL patterns for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range.
DescribePatternPerformanceDescribePatternPerformanceQueries the information about performance metrics of an SQL pattern such as the query duration and average memory usage for an AnalyticDB for MySQL cluster within a time range.

Storage analysis

APITitleDescription
APITitleDescription
DescribeDBClusterSpaceSummaryDescribeDBClusterSpaceSummaryQueries the storage overview information of an AnalyticDB for MySQL cluster, such as the total data size, hot data size, cold data size, and data growth.
DescribeExcessivePrimaryKeysDescribeExcessivePrimaryKeysQueries the information about tables that have excessive primary key fields in an AnalyticDB for MySQL Data Lakehouse Edition (V5.0) cluster.

O\\\\\\\\\\&M events

APITitleDescription
APITitleDescription
ModifyDBClusterMaintainTimeModifyDBClusterMaintainTimeModifies the maintenance window of an AnalyticDB for MySQL cluster.

Others

APITitleDescription
APITitleDescription
DescribeApsActionLogsDescribeApsActionLogsQueries the logs of a real-time data ingestion job for an AnalyticDB for MySQL cluster.

APITitleDescription
APITitleDescription
ModifyDBClusterVipModifyDBClusterVipChanges the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.
DescribeCompactionServiceSwitchDescribeCompactionServiceSwitchQueries whether the remote build feature is enabled in the query acceleration configuration of an AnalyticDB for MySQL cluster.
ModifyCompactionServiceSwitchModifyCompactionServiceSwitchModifies the status of the remote build feature in the query acceleration configuration of an AnalyticDB for MySQL cluster.
DeleteBackupsDeleteBackupsManually deletes backup sets.
  • On this page (1)
  • Region management
  • Cluster management
  • Resource group management
  • Elastic Plan Management
  • Log management
  • Account management
  • Monitoring management
  • Spark development
  • Database management
  • SQL diagnostics
  • Storage analysis
  • O\\\\\\\\\\&M events
  • Others
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare