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
API | Title | Description |
---|---|---|
CreateDBCluster | CreateDBCluster | |
DeleteDBCluster | DeleteDBCluster | Deletes an AnalyticDB for MySQL cluster. |
ModifyDBCluster | ModifyDBCluster | Changes the specifications of an AnalyticDB for MySQL cluster. |
ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | |
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 | |
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 (V3.0) 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 (V3.0) 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 |
Resource group management (old version)
API | Title | Description |
---|---|---|
CreateDBResourcePool | CreateDBResourcePool | |
DeleteDBResourcePool | DeleteDBResourcePool | |
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 | |
BindDBResourcePoolWithUser | BindDBResourcePoolWithUser |
Resource group management (new version)
API | Title | Description |
---|---|---|
CreateDBResourceGroup | CreateDBResourceGroup | Creates a resource group for an AnalyticDB for MySQL Data Warehouse Edition (V3.0) 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 Data Warehouse Edition (V3.0) 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. |
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. This operation can be used 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. |
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 | |
DescribeProcessList | DescribeProcessList | Queries the queries that are being executed on a cluster. |
DescribeColumns | DescribeColumns | |
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 | |
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. |
Log management
API | Title | Description |
---|---|---|
ModifyAuditLogConfig | ModifyAuditLogConfig | |
DescribeSlowLogRecords | DescribeSlowLogRecords | |
DescribeSlowLogTrend | DescribeSlowLogTrend | Queries the trend of slow query logs for an AnalyticDB for MySQL cluster. |
DescribeAuditLogConfig | DescribeAuditLogConfig | |
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 | |
DescribeDBClusterNetInfo | DescribeDBClusterNetInfo | |
AllocateClusterPublicConnection | AllocateClusterPublicConnection |
Account management
API | Title | Description |
---|---|---|
CreateAccount | CreateAccount | Creates a database account for an AnalyticDB for MySQL cluster. |
DeleteAccount | DeleteAccount | |
DescribeAccounts | DescribeAccounts | Queries a list of database accounts for an AnalyticDB for MySQL cluster. |
GrantOperatorPermission | GrantOperatorPermission | Grants permissions to the service account of an AnalyticDB for MySQL cluster. |
ResetAccountPassword | ResetAccountPassword |
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. |
Backup and restoration
API | Title | Description |
---|---|---|
ModifyBackupPolicy | ModifyBackupPolicy | |
ModifyLogBackupPolicy | ModifyLogBackupPolicy | Modifies the log backup settings of an AnalyticDB for MySQL cluster. |
DescribeBackups | DescribeBackups | Queries a list of backup sets for an AnalyticDB for MySQL cluster. |
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. |
Monitoring management
API | Title | Description |
---|---|---|
DescribeDBClusterHealthStatus | DescribeDBClusterHealthStatus | |
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 monitoring information about tables. |
O\\\&M events
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 | |
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 | |
ApplyAdviceById | ApplyAdviceById | |
BatchApplyAdviceByIdList | BatchApplyAdviceByIdList | |
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 |
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 |
---|---|---|
DescribeVSwitches | DescribeVSwitches | Queries the vSwitches. |
MigrateDBCluster | MigrateDBCluster | Migrates data from a Data Warehouse Edition (V3.0) cluster to a Data Lakehouse Edition (V3.0) cluster in AnalyticDB for MySQL. |
DescribeTableStatistics | DescribeTableStatistics | |
ModifyResubmitConfig | ModifyResubmitConfig | |
DescribeResubmitConfig | DescribeResubmitConfig | |
DescribeSQAConfig | DescribeSQAConfig | Queries the short query acceleration (SQA) configuration of an AnalyticDB for MySQL cluster. |
ModifySQAConfig | ModifySQAConfig |