All Products
Search
Document Center

AnalyticDB for MySQL:List of operations by function

Last Updated:Mar 19, 2024
This product(adb/2019-03-15) 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 (11370001915) 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.

Cluster management

APITitleDescription
CreateDBClusterCreateDBCluster
DeleteDBClusterDeleteDBClusterDeletes an AnalyticDB for MySQL cluster.
ModifyDBClusterModifyDBClusterChanges the specifications of an AnalyticDB for MySQL cluster.
ModifyDBClusterMaintainTimeModifyDBClusterMaintainTime
ModifyDBClusterPayTypeModifyDBClusterPayTypeChanges the billing method of an AnalyticDB for MySQL cluster.
ModifyAutoRenewAttributeModifyAutoRenewAttributeModifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster.
ModifyDBClusterDescriptionModifyDBClusterDescription
ModifyDBClusterResourceGroupModifyDBClusterResourceGroupModifies the resource group of an AnalyticDB for MySQL cluster.
DescribeDBClustersDescribeDBClustersQueries a list of AnalyticDB for MySQL clusters within a region.
DescribeDBClusterStatusDescribeDBClusterStatusQueries the status of AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
DescribeDBClusterAttributeDescribeDBClusterAttributeQueries the information about an AnalyticDB for MySQL cluster.
DescribeAutoRenewAttributeDescribeAutoRenewAttributeQueries the auto-renewal status of a subscription AnalyticDB for MySQL cluster.
DescribeAvailableResourceDescribeAvailableResourceQueries the resources of clusters within zones of a region.
DescribeComputeResourceDescribeComputeResourceQueries the specifications of computing resources for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
DescribeEIURangeDescribeEIURangeQueries the range for the number of elastic I/O units (EIUs) for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
AttachUserENIAttachUserENI
DetachUserENIDetachUserENI

Resource group management (old version)

APITitleDescription
CreateDBResourcePoolCreateDBResourcePool
DeleteDBResourcePoolDeleteDBResourcePool
ModifyDBResourcePoolModifyDBResourcePoolModifies the resources of a resource group. This operation is available only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
DescribeDBResourcePoolDescribeDBResourcePool
BindDBResourcePoolWithUserBindDBResourcePoolWithUser

Resource group management (new version)

APITitleDescription
CreateDBResourceGroupCreateDBResourceGroupCreates a resource group for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
BindDBResourceGroupWithUserBindDBResourceGroupWithUserAssociates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster with a database account.
UnbindDBResourceGroupWithUserUnbindDBResourceGroupWithUserDisassociates a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster from a database account.
DescribeDBResourceGroupDescribeDBResourceGroupQueries the information about a resource group for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
ModifyDBResourceGroupModifyDBResourceGroupModifies the number of nodes or the query execution mode for a resource group of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.
DeleteDBResourceGroupDeleteDBResourceGroupDeletes a resource group from an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Elastic Plan Management

APITitleDescription
CreateElasticPlanCreateElasticPlanCreates a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
DeleteElasticPlanDeleteElasticPlanDeletes a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
ModifyElasticPlanModifyElasticPlanModifies a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.
DescribeElasticDailyPlanDescribeElasticDailyPlan
DescribeElasticPlanDescribeElasticPlanQueries 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

APITitleDescription
DescribeTablesDescribeTablesQueries a list of tables in a database of an AnalyticDB for MySQL cluster.
DescribeAllDataSourceDescribeAllDataSourceQueries a list of databases, tables, and columns in a cluster.
DescribeSchemasDescribeSchemas
DescribeProcessListDescribeProcessListQueries the queries that are being executed on a cluster.
DescribeColumnsDescribeColumns
DescribeTaskInfoDescribeTaskInfoQueries the information about a task.
DescribeSQLPlanDescribeSQLPlanQueries the plan information about an SQL statement such as a query statement or an extract-transform-load (ETL) task statement.
DescribeSQLPlanTaskDescribeSQLPlanTask
DescribeTablePartitionDiagnoseDescribeTablePartitionDiagnoseQueries the information about partition diagnostics.
DescribeLoadTasksRecordsDescribeLoadTasksRecordsQueries the information about asynchronous import and export tasks of an AnalyticDB for MySQL cluster.
DescribeConnectionCountRecordsDescribeConnectionCountRecordsQueries the current number of connections to an AnalyticDB for MySQL cluster.

Log management

APITitleDescription
ModifyAuditLogConfigModifyAuditLogConfig
DescribeSlowLogRecordsDescribeSlowLogRecords
DescribeSlowLogTrendDescribeSlowLogTrendQueries the trend of slow query logs for an AnalyticDB for MySQL cluster.
DescribeAuditLogConfigDescribeAuditLogConfig
DescribeAuditLogRecordsDescribeAuditLogRecordsQueries the SQL audit logs of an AnalyticDB for MySQL cluster.

Region management

APITitleDescription
DescribeRegionsDescribeRegionsQueries a list of available regions and zones for AnalyticDB for MySQL.

Network management

APITitleDescription
ModifyClusterConnectionStringModifyClusterConnectionString
DescribeDBClusterNetInfoDescribeDBClusterNetInfo
AllocateClusterPublicConnectionAllocateClusterPublicConnection

Account management

APITitleDescription
CreateAccountCreateAccountCreates a database account for an AnalyticDB for MySQL cluster.
DeleteAccountDeleteAccount
DescribeAccountsDescribeAccountsQueries a list of database accounts for an AnalyticDB for MySQL cluster.
GrantOperatorPermissionGrantOperatorPermissionGrants permissions to the service account of an AnalyticDB for MySQL cluster.
ResetAccountPasswordResetAccountPassword

Tag management

APITitleDescription
ListTagResourcesListTagResourcesQueries the tags that are added to AnalyticDB for MySQL clusters, or the AnalyticDB for MySQL clusters that have tags added.
TagResourcesTagResourcesAdds tags to an AnalyticDB for MySQL cluster.
UntagResourcesUntagResourcesRemoves all tags from AnalyticDB for MySQL clusters.

Backup and restoration

APITitleDescription
ModifyBackupPolicyModifyBackupPolicy
ModifyLogBackupPolicyModifyLogBackupPolicyModifies the log backup settings of an AnalyticDB for MySQL cluster.
DescribeBackupsDescribeBackupsQueries a list of backup sets for an AnalyticDB for MySQL cluster.

Security management

APITitleDescription
ModifyDBClusterAccessWhiteListModifyDBClusterAccessWhiteListModifies the IP address whitelists of a cluster.
DescribeDBClusterAccessWhiteListDescribeDBClusterAccessWhiteListQueries a list of IP address whitelists for an AnalyticDB for MySQL cluster.

Monitoring management

APITitleDescription
DescribeDBClusterHealthStatusDescribeDBClusterHealthStatus
DescribeDBClusterPerformanceDescribeDBClusterPerformanceQueries the performance data of an AnalyticDB for MySQL cluster.
DescribeDBClusterResourcePoolPerformanceDescribeDBClusterResourcePoolPerformanceQueries the monitoring information about resource groups within an AnalyticDB for MySQL cluster.
DescribeInclinedTablesDescribeInclinedTablesQueries the monitoring information about tables.

O\\\&M events

APITitleDescription
ModifyMaintenanceActionModifyMaintenanceActionChanges the switchover time of O\&M events.
DescribeMaintenanceActionDescribeMaintenanceActionQueries the information about O\&M events.

SQL diagnostics

APITitleDescription
DescribeDiagnosisTasksDescribeDiagnosisTasksQueries the execution information about distributed tasks in a stage of a query.
DescribeDiagnosisRecordsDescribeDiagnosisRecordsQueries the diagnostic information about SQL statements that meet a condition in an AnalyticDB for MySQL cluster.
DescribeDiagnosisDimensionsDescribeDiagnosisDimensionsQueries 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.
DescribeDownloadRecordsDescribeDownloadRecords
DownloadDiagnosisRecordsDownloadDiagnosisRecordsDownloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL cluster.
DescribeDiagnosisSQLInfoDescribeDiagnosisSQLInfoQueries the execution information about an SQL statement, including the execution plan, execution information, resource usage, and self-diagnostics results.
DescribeDiagnosisMonitorPerformanceDescribeDiagnosisMonitorPerformanceQueries the monitoring information about queries within a time range.
DescribeSQLPatternsDescribeSQLPatternsQueries a list of SQL patterns for an AnalyticDB for MySQL cluster within a period of time.
DescribePatternPerformanceDescribePatternPerformanceQueries the metrics of an SQL pattern such as the query duration and average memory usage within a period of time.
EnableAdviceServiceEnableAdviceService
ApplyAdviceByIdApplyAdviceById
BatchApplyAdviceByIdListBatchApplyAdviceByIdList
DescribeAdviceServiceEnabledDescribeAdviceServiceEnabledQueries whether the suggestion feature is enabled for an AnalyticDB for MySQL cluster.
DescribeAppliedAdvicesDescribeAppliedAdvicesQueries the applied optimization suggestions for an AnalyticDB for MySQL cluster.
DescribeAvailableAdvicesDescribeAvailableAdvicesQueries the available suggestions for cluster optimization.
DisableAdviceServiceDisableAdviceService

Cluster running reports

APITitleDescription
DescribeTableAccessCount DescribeTableAccessCount
DescribeSqlPatternDescribeSqlPatternQueries a list of SQL patterns for an AnalyticDB for MySQL cluster within a time range.

Others

APITitleDescription
DescribeVSwitchesDescribeVSwitchesQueries the vSwitches.
MigrateDBClusterMigrateDBClusterMigrates data from a Data Warehouse Edition (V3.0) cluster to a Data Lakehouse Edition (V3.0) cluster in AnalyticDB for MySQL.
DescribeTableStatisticsDescribeTableStatistics
ModifyResubmitConfigModifyResubmitConfig
DescribeResubmitConfigDescribeResubmitConfig
DescribeSQAConfigDescribeSQAConfigQueries the short query acceleration (SQA) configuration of an AnalyticDB for MySQL cluster.
ModifySQAConfigModifySQAConfig