API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (DAS/2020-01-16) 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.
API list
|
API |
Title |
Description |
| AddHDMInstance | AddHDMInstance | Adds a database instance to Database Autonomy Service (DAS). |
| Chat | Chat | An asynchronous API to access the large language model capabilities of DAS. |
| CreateCacheAnalysisJob | CreateCacheAnalysisJob | Creates a cache analysis task. |
| CreateCloudBenchTasks | CreateCloudBenchTasks | You can call the CreateCloudBenchTasks operation to create a stress testing task. |
| CreateDiagnosticReport | CreateDiagnosticReport | Creates a diagnostic report. |
| CreateKillInstanceSessionTask | CreateKillInstanceSessionTask | Creates a task that terminates sessions. |
| CreateLatestDeadLockAnalysis | CreateLatestDeadLockAnalysis | Triggers an on-demand analysis of the most recent deadlock event captured by the database instance. |
| CreateQueryOptimizeTag | CreateQueryOptimizeTag | Adds a tag to a SQL template. |
| CreateRequestDiagnosis | CreateRequestDiagnosis | Initiates an SQL statement diagnostics request. |
| CreateSecurityIPGroup | CreateSecurityIPGroup | Creates a whitelist template that can be used across multiple products. |
| CreateSqlLogTask | CreateSqlLogTask | Creates an offline task for Database Autonomy Service (DAS) Enterprise Edition. |
| CreateStorageAnalysisTask | CreateStorageAnalysisTask | Creates a storage analysis task to query the usage details of one or more databases and tables. |
| DeleteCloudBenchTask | DeleteCloudBenchTask | Deletes a stress testing task. |
| DeleteSecurityIPGroup | DeleteSecurityIPGroup | Deletes a cross-product whitelist template. |
| DeleteStopGateway | DeleteStopGateway | Deletes the metadata of a stopped database gateway. |
| DescribeAutoScalingConfig | DescribeAutoScalingConfig | Queries the configurations of the auto scaling feature for an instance. |
| DescribeAutoScalingHistory | DescribeAutoScalingHistory | Queries the auto scaling history of an instance. |
| DescribeCacheAnalysisJob | DescribeCacheAnalysisJob | Returns details of a cache analysis task. |
| DescribeCacheAnalysisJobs | DescribeCacheAnalysisJobs | Queries a list of cache analysis tasks. |
| DescribeCloudBenchTasks | DescribeCloudBenchTasks | You can call the DescribeCloudBenchTasks operation to query stress testing tasks. |
| DescribeCloudbenchTask | DescribeCloudbenchTask | Queries a specific stress testing task. |
| DescribeCloudbenchTaskConfig | DescribeCloudbenchTaskConfig | Retrieves the detailed configuration, file paths, and execution commands for a specific stress test task. |
| DescribeDiagnosticReportList | DescribeDiagnosticReportList | Queries diagnostics reports. |
| DescribeErrorLogRecords | DescribeErrorLogRecords | Queries the details of error logs for a specific database instance within a specified time range. |
| DescribeHotBigKeys | DescribeHotBigKeys | Call the DescribeHotBigKeys operation to retrieve real-time data about hot keys and big keys in memory. |
| DescribeHotKeys | DescribeHotKeys | Checks the hot keys of a Redis instance. |
| DescribeInstanceDasPro | DescribeInstanceDasPro | Queries whether Database Autonomy Service (DAS) Enterprise Edition V1 or V2 is enabled for a database instance. |
| DescribeQueryExplain | DescribeQueryExplain | Obtain the execution plan for an SQL statement. |
| DescribeSecurityIPGroup | DescribeSecurityIPGroup | Views the details of a cross-product whitelist template. |
| DescribeSecurityIPGroupRelation | DescribeSecurityIPGroupRelation | Queries how cross-product whitelist templates are attached to instances. |
| DescribeSlowLogHistogramAsync | DescribeSlowLogHistogramAsync | Asynchronously retrieves the slow log trend data of an instance. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the slow log records of a database instance. You can filter and sort the records based on various conditions. |
| DescribeSlowLogStatistic | DescribeSlowLogStatistic | Retrieves slow query log statistics. |
| DescribeSqlLogConfig | DescribeSqlLogConfig | Queries the configurations of Database Autonomy Service (DAS) Enterprise Edition that is enabled for a database instance. |
| DescribeSqlLogRecords | DescribeSqlLogRecords | Call DescribeSqlLogRecords to query log details in DAS Enterprise Edition. |
| DescribeSqlLogStatistic | DescribeSqlLogStatistic | Call the `DescribeSqlLogStatistic` operation to query data statistics for DAS Enterprise Edition. |
| DescribeSqlLogTask | DescribeSqlLogTask | Call the `DescribeSqlLogTask` operation to query the details of an offline task in DAS enterprise edition. |
| DescribeSqlLogTasks | DescribeSqlLogTasks | Lists the audit log tasks for an instance. |
| DescribeTopBigKeys | DescribeTopBigKeys | Queries the top 100 large keys over a period of time. |
| DescribeTopHotKeys | DescribeTopHotKeys | Queries the top 100 hot keys within a specified time period. |
| DisableAllSqlConcurrencyControlRules | DisableAllSqlConcurrencyControlRules | Disables all throttling rules that are in effect. |
| DisableAutoResourceOptimizeRules | DisableAutoResourceOptimizeRules | Disables the automatic tablespace fragment recycling feature for database instances at a time. |
| DisableAutoThrottleRules | DisableAutoThrottleRules | Disables the automatic SQL throttling feature for multiple database instances at a time. |
| DisableDasPro | DisableDasPro | Deactivates Database Autonomy Service (DAS) Professional Edition. |
| DisableInstanceDasConfig | DisableInstanceDasConfig | Disables the auto scaling feature for a database instance. |
| DisableSqlConcurrencyControl | DisableSqlConcurrencyControl | Disables a throttling rule. |
| EnableDasPro | EnableDasPro | Activates Database Autonomy Service (DAS) Professional Edition. |
| EnableSqlConcurrencyControl | EnableSqlConcurrencyControl | Enables SQL throttling to control the numbers of database access requests and concurrent SQL statements. |
| GetAsyncErrorRequestListByCode | GetAsyncErrorRequestListByCode | Asynchronously queries the IDs of SQL statements that generate a MySQL error code in the SQL Explorer results of a database instance. |
| GetAsyncErrorRequestStatByCode | GetAsyncErrorRequestStatByCode | Asynchronously queries the MySQL error codes in SQL Explorer data and the number of SQL queries corresponding to each error code. |
| GetAsyncErrorRequestStatResult | GetAsyncErrorRequestStatResult | Call GetAsyncErrorRequestStatResult to asynchronously get the execution error count for a specific SQL statement from the SQL Insight results of a database instance. |
| GetAutoIncrementUsageStatistic | GetAutoIncrementUsageStatistic | Queries the usage of auto-increment table IDs. |
| GetAutoResourceOptimizeRules | GetAutoResourceOptimizeRules | Queries the automatic fragment recycling rules of database instances. |
| GetAutoThrottleRules | GetAutoThrottleRules | Queries the automatic SQL throttling rules of a database instance. |
| GetAutonomousNotifyEventContent | GetAutonomousNotifyEventContent | Returns details of autonomous notification events for a database instance. |
| GetAutonomousNotifyEventsInRange | GetAutonomousNotifyEventsInRange | Queries the notification events of one or more urgency levels within a period. |
| GetBlockingDetailList | GetBlockingDetailList | Queries the blocking data of an ApsaraDB RDS for SQL Server instance. |
| GetDBInstanceConnectivityDiagnosis | GetDBInstanceConnectivityDiagnosis | Queries the diagnosis of network connectivity when a user accesses a specific database instance by specifying an IP address. |
| GetDasAgentSSE | GetDasAgentSSE | This API uses Server-Sent Events (SSE) to interact with the DAS agent. You can use this API for features such as Q&A and performance diagnostics. |
| GetDasProServiceUsage | GetDasProServiceUsage | Queries the storage usage of a database instance for which Database Autonomy Service (DAS) Enterprise Edition V1 or V2 is enabled. |
| GetDasSQLLogHotData | GetDasSQLLogHotData | Retrieves hot data from SQL audit logs. |
| GetDeadLockDetail | GetDeadLockDetail | Retrieves the detailed information for a single deadlock event. |
| GetDeadLockDetailList | GetDeadLockDetailList | Queries the deadlock details of an ApsaraDB RDS for SQL Server instance. |
| GetDeadLockHistory | GetDeadLockHistory | Retrieves the historical analysis tasks for recent and full deadlock analysis. |
| GetDeadlockHistogram | GetDeadlockHistogram | Retrieves a time-series histogram of deadlock occurrences based on the full deadlock analysis of error logs within a specified time range. |
| GetErrorRequestSample | GetErrorRequestSample | Asynchronously queries information about failed SQL queries in SQL Explorer data. You can query up to 20 failed SQL queries within the specific time range. |
| GetEventSubscription | GetEventSubscription | Queries the event subscription settings of a database instance. |
| GetFullRequestOriginStatByInstanceId | GetFullRequestOriginStatByInstanceId | Collects the full request statistics in the SQL Explorer results of a database instance by access source. |
| GetFullRequestSampleByInstanceId | GetFullRequestSampleByInstanceId | Queries sample SQL statements in the SQL Explorer data of a database instance by SQL ID. You can query up to 20 sample SQL statements. |
| GetFullRequestStatResultByInstanceId | GetFullRequestStatResultByInstanceId | Asynchronously collects the full request statistics in the SQL Explorer results of a database instance by SQL ID. |
| GetInstanceGroupInspectReportDetail | GetInstanceGroupInspectReportDetail | Retrieves details of DAS Agent O&M reports. |
| GetInstanceGroupInspectReportList | GetInstanceGroupInspectReportList | Queries a list of Operations and Maintenance (O&M) reports generated by DAS Agent. |
| GetInstanceInspections | GetInstanceInspections | Queries the result of an inspection that is performed on a database instance by using the inspection and scoring feature. |
| GetInstanceMissingIndexList | GetInstanceMissingIndexList | Returns details of all missing indexes for an instance. |
| GetInstanceSqlOptimizeStatistic | GetInstanceSqlOptimizeStatistic | Queries statistics on automatic SQL optimization events within a period of time, such as the total number of optimization events and the maximum improvement. |
| GetKillInstanceSessionTaskResult | GetKillInstanceSessionTaskResult | Queries the results of a task that terminates sessions. |
| GetMongoDBCurrentOp | GetMongoDBCurrentOp | Queries the current sessions of an ApsaraDB for MongoDB (MongoDB) instance. |
| GetMySQLAllSessionAsync | GetMySQLAllSessionAsync | Asynchronously queries the sessions of an instance and collects statistics on the sessions based on dimensions. |
| GetPartitionsHeatmap | GetPartitionsHeatmap | Queries access frequency statistics and hot data on partitions of a PolarDB-X 2.0 instance. |
| GetPfsMetricTrends | GetPfsMetricTrends | Queries the trend of a metric for the new version of the performance insight feature of a database instance. |
| GetPfsSqlSample | GetPfsSqlSample | Queries the SQL sample data for the new version of the performance insight feature of a database instance. |
| GetPfsSqlSummaries | GetPfsSqlSummaries | Call the GetPfsSqlSummaries API to query all request data using the SQL ID dimension in Performance Insight (New Version) for a database instance. |
| GetQueryOptimizeDataStats | GetQueryOptimizeDataStats | Returns SQL template statistics from query governance data. |
| GetQueryOptimizeDataTop | GetQueryOptimizeDataTop | Returns the best- and worst-performing instances based on query governance data. |
| GetQueryOptimizeDataTrend | GetQueryOptimizeDataTrend | Queries query governance trend data. |
| GetQueryOptimizeExecErrorSample | GetQueryOptimizeExecErrorSample | Queries the failed SQL statements under a SQL template. |
| GetQueryOptimizeExecErrorStats | GetQueryOptimizeExecErrorStats | Queries SQL templates that failed to be executed. |
| GetQueryOptimizeRuleList | GetQueryOptimizeRuleList | Queries the tags added by the query governance feature to specified database instances. |
| GetQueryOptimizeShareUrl | GetQueryOptimizeShareUrl | Queries a share URL provided by the query governance feature. |
| GetQueryOptimizeSolution | GetQueryOptimizeSolution | Queries suggestions provided by query governance for optimizing an SQL template. |
| GetQueryOptimizeTag | GetQueryOptimizeTag | Queries the tags of a SQL statement. |
| GetRedisAllSession | GetRedisAllSession | Queries the current session on an ApsaraDB for Redis instance. |
| GetRequestDiagnosisPage | GetRequestDiagnosisPage | Queries SQL diagnostics records by pages. |
| GetRequestDiagnosisResult | GetRequestDiagnosisResult | Call GetRequestDiagnosisResult to retrieve the SQL diagnosis results. |
| GetRunningSqlConcurrencyControlRules | GetRunningSqlConcurrencyControlRules | Queries the throttling rules that are in effect. |
| GetSqlConcurrencyControlKeywordsFromSqlText | GetSqlConcurrencyControlKeywordsFromSqlText | Generates a throttling keyword string based on an SQL statement. |
| GetSqlConcurrencyControlRulesHistory | GetSqlConcurrencyControlRulesHistory | Queries the throttling rules that are being executed or have been triggered. |
| GetSqlOptimizeAdvice | GetSqlOptimizeAdvice | Queries optimization suggestions that are generated by the SQL diagnostics feature of Database Autonomy Service (DAS). |
| GetStorageAnalysisResult | GetStorageAnalysisResult | Queries the status and results of a storage analysis task. |
| GetYaoChiAgent | GetYaoChiAgent | The Yaochi Agent large model interface provides capabilities for question answering and performance diagnosis. |
| KillInstanceAllSession | KillInstanceAllSession | Terminates all sessions on an instance. |
| ModifyAutoScalingConfig | ModifyAutoScalingConfig | Modifies the auto scaling configurations of an instance. |
| ModifySecurityIPGroup | ModifySecurityIPGroup | Modifies a cross-product whitelist template. |
| ModifySecurityIPGroupRelation | ModifySecurityIPGroupRelation | Attaches or detaches a cross-product whitelist template. |
| ModifySqlLogConfig | ModifySqlLogConfig | Use the `ModifySqlLogConfig` operation to enable or configure DAS Enterprise Edition for a database instance. |
| RunCloudBenchTask | RunCloudBenchTask | Calls the RunCloudBenchTask operation to execute a stress testing task. |
| SetEventSubscription | SetEventSubscription | Configures the event subscription settings for a database instance. |
| UpdateAutoResourceOptimizeRulesAsync | UpdateAutoResourceOptimizeRulesAsync | Asynchronously configures parameters related to the automatic fragment recycling feature for multiple database instances at a time. |
| UpdateAutoSqlOptimizeStatus | UpdateAutoSqlOptimizeStatus | Enables, modifies, or disables the automatic SQL optimization feature for multiple database instances at a time. |
| UpdateAutoThrottleRulesAsync | UpdateAutoThrottleRulesAsync | Asynchronously configures parameters related to the automatic SQL throttling feature for multiple database instances at a time. |