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