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 (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.
Region management
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries a list of regions and zones in which AnalyticDB for MySQL Data Lakehouse Edition (V3.0) is available. |
Cluster management
| API | Title | Description |
|---|---|---|
| CreateDBCluster | CreateDBCluster | Creates an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyDBCluster | ModifyDBCluster | Changes the configurations of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeDBClusters | DescribeDBClusters | Queries the information about AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in a region. |
| DescribeDBClusterAttribute | DescribeDBClusterAttribute | Queries the information about an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DeleteDBCluster | DeleteDBCluster | Deletes an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyDBClusterDescription | ModifyDBClusterDescription | Modifies the description of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster to facilitate the maintenance and management of the cluster. |
| DescribeClusterNetInfo | DescribeClusterNetInfo | Queries the network information about an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| AllocateClusterPublicConnection | AllocateClusterPublicConnection | Applies for a public endpoint for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ReleaseClusterPublicConnection | ReleaseClusterPublicConnection | Releases the public endpoint of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyClusterConnectionString | ModifyClusterConnectionString | Modifies the public endpoint of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeClusterAccessWhiteList | DescribeClusterAccessWhiteList | Queries the IP address whitelist of an AnalyticDB for MySQL cluster. |
| ModifyClusterAccessWhiteList | ModifyClusterAccessWhiteList | Modifies the IP address whitelist of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Resource group management
| API | Title | Description |
|---|---|---|
| CreateDBResourceGroup | CreateDBResourceGroup | Creates a resource group for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeDBResourceGroup | DescribeDBResourceGroup | Queries the information about resource groups for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyDBResourceGroup | ModifyDBResourceGroup | Modifies the amount of reserved computing resources for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DeleteDBResourceGroup | DeleteDBResourceGroup | Deletes a resource group from an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Elastic Plan Management
| API | Title | Description |
|---|---|---|
| CreateElasticPlan | CreateElasticPlan | Creates a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeElasticPlans | DescribeElasticPlans | Queries scaling plans of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyElasticPlan | ModifyElasticPlan | Modifies a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| EnableElasticPlan | EnableElasticPlan | Enables a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DisableElasticPlan | DisableElasticPlan | Disables a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DeleteElasticPlan | DeleteElasticPlan | Deletes a scaling plan from an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeElasticPlanJobs | DescribeElasticPlanJobs | Queries a list of scaling plan jobs for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeElasticPlanAttribute | DescribeElasticPlanAttribute | Queries the information about a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeElasticPlanSpecifications | DescribeElasticPlanSpecifications | Queries the resource specifications that are supported by different types of scaling plans of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Log management
| API | Title | Description |
|---|---|---|
| DescribeAuditLogRecords | DescribeAuditLogRecords | Queries the SQL audit logs of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyAuditLogConfig | ModifyAuditLogConfig | Modifies the SQL audit configuration of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates a database account for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeAccounts | DescribeAccounts | Queries the database accounts of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| BindAccount | BindAccount | Associates a standard database account of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster with a Resource Access Management (RAM) user. |
| UnbindAccount | UnbindAccount | Disassociates a standard database account of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster from a Resource Access Management (RAM) user. |
| CheckBindRamUser | CheckBindRamUser | Queries whether a database account of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster is associated with a Resource Access Management (RAM) user. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DeleteAccount | DeleteAccount | Deletes a database account from an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ModifyAccountPrivileges | ModifyAccountPrivileges | Modifies the permissions of a database account. |
| DescribeAccountPrivileges | DescribeAccountPrivileges | Queries the permissions of a database account on a specified permission level. |
| DescribeEnabledPrivileges | DescribeEnabledPrivileges | Queries the permission level and permissions supported for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeAccountAllPrivileges | DescribeAccountAllPrivileges | Queries the permissions of a database account on all permission levels. |
| DescribeAccountPrivilegeObjects | DescribeAccountPrivilegeObjects | Queries the databases, tables, and columns on which a database account has permissions. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeDBClusterHealthStatus | DescribeDBClusterHealthStatus | Queries the health status of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the performance data of an AnalyticDB for MySQL cluster. |
Spark development
| API | Title | Description |
|---|---|---|
| GetSparkDefinitions | GetSparkDefinitions | Queries the common definitions of Spark applications. |
| PreloadSparkAppMetrics | PreloadSparkAppMetrics | Preloads metrics for a Spark application. |
| GetSparkAppMetrics | GetSparkAppMetrics | Queries the metrics of a Spark application. |
| ListSparkLogAnalyzeTasks | ListSparkLogAnalyzeTasks | Queries a list of Spark log analysis tasks. |
| SubmitSparkLogAnalyzeTask | SubmitSparkLogAnalyzeTask | Submits a Spark log analysis task and queries the analysis results. |
| KillSparkLogAnalyzeTask | KillSparkLogAnalyzeTask | Terminates a Spark log analysis task and queries the information about the analysis task. |
| GetSparkLogAnalyzeTask | GetSparkLogAnalyzeTask | Queries the results of a Spark log analysis task. |
| SetSparkAppLogRootPath | SetSparkAppLogRootPath | Modifies the Spark log configuration. |
| GetSparkConfigLogPath | GetSparkConfigLogPath | Queries the Spark log configuration of an AnalyticDB for MySQL cluster, including the default Spark log path. |
| StartSparkSQLEngine | StartSparkSQLEngine | Starts the Spark SQL engine. |
| KillSparkSQLEngine | KillSparkSQLEngine | Shuts down a Spark SQL engine. |
| GetSparkSQLEngineState | GetSparkSQLEngineState | Queries the state information about the Spark SQL engine. |
| ListSparkTemplateFileIds | ListSparkTemplateFileIds | Queries all Spark template file IDs of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| GetSparkAppWebUiAddress | GetSparkAppWebUiAddress | Queries the URL of the web UI for a Spark application. |
| ListSparkAppAttempts | ListSparkAppAttempts | Queries the information about retry attempts of a Spark application. |
| CreateSparkTemplate | CreateSparkTemplate | Creates a Spark application template. |
| DeleteSparkTemplate | DeleteSparkTemplate | Deletes Spark template files. |
| GetSparkTemplateFolderTree | GetSparkTemplateFolderTree | Queries the directory structure of Spark applications. |
| GetSparkTemplateFullTree | GetSparkTemplateFullTree | Queries the directory structure of Spark applications. |
| GetSparkTemplateFileContent | GetSparkTemplateFileContent | Queries the content of a Spark application template. |
| UpdateSparkTemplateFile | UpdateSparkTemplateFile | Updates a Spark application template. |
| DeleteSparkTemplateFile | DeleteSparkTemplateFile | Deletes Spark template files. |
| GetSparkAppAttemptLog | GetSparkAppAttemptLog | Queries the information about the retry log of a Spark application. |
| ListSparkApps | ListSparkApps | Queries the Spark applications that run on an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| GetSparkAppInfo | GetSparkAppInfo | Queries the information about an Spark application. |
| GetSparkAppState | GetSparkAppState | Queries the status of a Spark application. |
| GetSparkAppLog | GetSparkAppLog | Queries the logs of a Spark application. |
| SubmitSparkApp | SubmitSparkApp | Submits a Spark application. |
| KillSparkApp | KillSparkApp | Terminates a Spark application. |
Database management
| API | Title | Description |
|---|---|---|
| DescribeAdbMySqlColumns | DescribeAdbMySqlColumns | Queries the information about table columns for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeAdbMySqlTables | DescribeAdbMySqlTables | Queries a list of tables for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeAdbMySqlSchemas | DescribeAdbMySqlSchemas | Queries a list of databases for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| GetViewDDL | GetViewDDL | Queries the statement that is used to create a view. |
| GetViewObjects | GetViewObjects | Queries the information about views. |
| GetDatabaseObjects | GetDatabaseObjects | Queries the information about databases. |
| GetTable | GetTable | Queries the information about a table. |
| GetTableColumns | GetTableColumns | Queries the information about columns. |
| GetTableDDL | GetTableDDL | Queries the statement that is used to create a table. |
| GetTableObjects | GetTableObjects | Query the details of one or more tables. |
SQL diagnostics
| API | Title | Description |
|---|---|---|
| DescribeSqlPattern | DescribeSqlPattern | Queries the information about SQL patterns of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range. |
| DescribeSQLPatterns | DescribeSQLPatterns | Queries a list of SQL patterns for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range. |
| DescribePatternPerformance | DescribePatternPerformance | Queries the information about performance metrics of an SQL pattern such as the query duration and average memory usage for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster within a time range. |
| API | Title | Description |
|---|---|---|
| DescribeDBClusterSpaceSummary | DescribeDBClusterSpaceSummary | Queries 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. |
O\\\&M events
| API | Title | Description |
|---|---|---|
| ModifyDBClusterMaintainTime | ModifyDBClusterMaintainTime | Modifies the maintenance window of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Aps Action
| API | Title | Description |
|---|---|---|
| DescribeApsActionLogs | DescribeApsActionLogs | Queries the logs of a real-time data ingestion task for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
Others
| API | Title | Description |
|---|---|---|
| BindDBResourceGroupWithUser | BindDBResourceGroupWithUser | Associates a resource group with a database account. |
| UnbindDBResourceGroupWithUser | UnbindDBResourceGroupWithUser | Disassociates resource groups from database accounts for an AnalyticDB for MySQL cluster. |
| DescribeDBClusterStatus | DescribeDBClusterStatus | Queries a list of states for AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters. |
| DetachUserENI | DetachUserENI | |
| AttachUserENI | AttachUserENI | Attaches an elastic network interface (ENI) to an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| ExistRunningSQLEngine | ExistRunningSQLEngine | Queries whether a running SQL engine exists. |
| CheckSampleDataSet | CheckSampleDataSet | |
| DescribeUserQuota | DescribeUserQuota | |
| DescribeAllDataSource | DescribeAllDataSource | Queries a list of databases, tables, and columns in an AnalyticDB for MySQL cluster. |
| DescribeTables | DescribeTables | Queries a list of tables in a database. |
| DescribeSchemas | DescribeSchemas | Queries a list of databases in an AnalyticDB for MySQL cluster. |
| DescribeColumns | DescribeColumns | Queries a list of columns in a table. |
| RenameSparkTemplateFile | RenameSparkTemplateFile | Renames a Spark template file. |
| LoadSampleDataSet | LoadSampleDataSet | Loads a built-in dataset. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup policy of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeBackupPolicy | DescribeBackupPolicy | |
| DescribeBackups | DescribeBackups | |
| DescribeStorageResourceUsage | DescribeStorageResourceUsage | Queries the storage resource usage of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. |
| DescribeClusterResourceDetail | DescribeClusterResourceDetail | |
| DescribeJobResourceUsage | DescribeJobResourceUsage | |
| DescribeClusterResourceUsage | DescribeClusterResourceUsage | |
| DescribeComputeResourceUsage | DescribeComputeResourceUsage | |
| DescribeApsResourceGroups | DescribeApsResourceGroups | Queries the information about resource groups of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster, including the resource metrics. |