API standards and multilingual preset SDKs
The OpenAPI of this product (DAS/2020-01-16) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Instance access
|
API |
Title |
Description |
| AddHDMInstance | Connect a database instance | Calls the AddHDMInstance operation to connect a database instance to Database Autonomy Service (DAS). |
Inspection and 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 notification
|
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 | 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. |
Diagnostic report
|
API |
Title |
Description |
| CreateDiagnosticReport | CreateDiagnosticReport | Creates a diagnostic report. |
| DescribeDiagnosticReportList | DescribeDiagnosticReportList | Queries diagnostics reports. |
| GetDBInstanceConnectivityDiagnosis | Retrieve network connectivity diagnosis result for a database instance | Retrieves the network connectivity diagnosis result from a user-specified IP address to a specified database instance. |
Cache analysis
|
API |
Title |
Description |
| CreateCacheAnalysisJob | Create a cache analysis task | Creates a cache analysis task by calling the CreateCacheAnalysisJob operation. |
| DescribeCacheAnalysisJob | DescribeCacheAnalysisJob | Returns 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 | Call GetRequestDiagnosisResult to retrieve the SQL diagnosis results. |
| GetRequestDiagnosisPage | GetRequestDiagnosisPage | Queries SQL diagnostics records by pages. |
| DescribeQueryExplain | DescribeQueryExplain | Obtain the execution plan for an SQL statement. |
Key analysis
|
API |
Title |
Description |
| DescribeHotBigKeys | Retrieve current hot keys and big keys in real time | Calls the DescribeHotBigKeys operation to retrieve the hot keys and big keys in the current memory in real time. |
| DescribeTopHotKeys | DescribeTopHotKeys | Queries the top 100 hot keys within a specified time period. |
| DescribeTopBigKeys | DescribeTopBigKeys | Queries the top 100 large keys over a period of time. |
| DescribeHotKeys | Query hot keys of an instance | Queries the hot keys of a Redis instance by calling the DescribeHotKeys operation. |
Query governance
|
API |
Title |
Description |
| CreateQueryOptimizeTag | Add tags to target SQL statements | Calls the CreateQueryOptimizeTag operation to add tags to target SQL statements. |
| 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 | Returns the best- and worst-performing instances based on query governance data. |
| GetQueryOptimizeDataStats | GetQueryOptimizeDataStats | Returns SQL template statistics from query governance data. |
| GetQueryOptimizeTag | Get SQL tags | Queries the tags of a specified SQL statement by calling the GetQueryOptimizeTag operation. |
| 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 GetAsyncErrorRequestStatResult to asynchronously get the execution error count for a specific SQL statement from the SQL Insight 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 | Query SQL sample data by SQL ID | Queries SQL sample data from the SQL Explorer results of a database instance by SQL ID by calling the GetFullRequestSampleByInstanceId operation. A maximum of 20 sample records are returned. |
Enterprise edition management
|
API |
Title |
Description |
| DescribeSqlLogConfig | Query DAS enterprise edition configuration | Queries the DAS Enterprise Edition configuration of a database instance. |
| ModifySqlLogConfig | ModifySqlLogConfig | Use the `ModifySqlLogConfig` operation to enable or configure DAS Enterprise Edition for a database instance. |
| DescribeSqlLogStatistic | Query DAS Enterprise Edition statistics information | Invokes the DescribeSqlLogStatistic operation to query the statistics information of DAS Enterprise Edition. |
| GetDasSQLLogHotData | GetDasSQLLogHotData | Retrieves hot data from SQL audit logs. |
| CreateSqlLogTask | Create a DAS enterprise edition batch task | Creates an asynchronous task for detailed data. |
| DescribeSqlLogTask | Query DAS enterprise edition batch task details | Queries the details of a DAS Enterprise Edition batch task by calling the DescribeSqlLogTask operation. |
| DescribeSqlLogTasks | List DAS enterprise edition batch tasks | Queries the list of audit log tasks for an instance. |
Instance session
|
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 | Terminate all sessions | Calls the KillInstanceAllSession operation to terminate all sessions on a specified instance. |
| CreateKillInstanceSessionTask | Create a task to terminate sessions | Calls the CreateKillInstanceSessionTask operation to create 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. |
Storage 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. |
Locking 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 | Create a recent deadlock analysis task | Creates a recent deadlock analysis task. |
| 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 | Query the trend of deadlock counts in full deadlock analysis within a time range | Queries the trend of deadlock counts based on full deadlock analysis of error logs within a specified time range. |
Index diagnostics
|
API |
Title |
Description |
| GetInstanceMissingIndexList | GetInstanceMissingIndexList | Returns details of all missing indexes for an instance. |
Slow logs
|
API |
Title |
Description |
| DescribeSlowLogHistogramAsync | Asynchronously retrieve slow log trends data for an instance | Asynchronously retrieves the slow log trends data of an instance. |
| DescribeSlowLogStatistic | Slow query log statistics information | Retrieves slow query log statistics information. |
| DescribeSlowLogRecords | Query slow query log records | Queries slow query log records of a database instance. You can filter and sort the results by multiple conditions. |
Automatic SQL throttling
|
API |
Title |
Description |
| UpdateAutoThrottleRulesAsync | Set automatic SQL throttling parameters | Calls the UpdateAutoThrottleRulesAsync operation to asynchronously configure automatic SQL throttling parameters for specified database instances in batches. |
| 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 | Query diagnostic suggestions generated by automatic SQL optimization | Queries the diagnostic suggestions generated by the DAS automatic SQL optimization feature. |
| 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 space 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. |
Automatic elastic scaling
|
API |
Title |
Description |
| ModifyAutoScalingConfig | Modify the elastic scaling configuration of an instance | Modifies the elastic scaling configuration of an instance. |
| DescribeAutoScalingConfig | Query instance elastic scaling feature configuration | Invokes the DescribeAutoScalingConfig operation to query the elastic scaling feature configuration of an instance. |
| DescribeAutoScalingHistory | Query instance elastic scaling history | Queries the elastic scaling history of an instance. |
| DisableInstanceDasConfig | DisableInstanceDasConfig | Disables the auto scaling feature for a database instance. |
Partition heat map
|
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 | Call the GetPfsSqlSummaries API to query all request data using the SQL ID dimension in Performance Insight (New Version) for a database instance. |
Error log
|
API |
Title |
Description |
| DescribeErrorLogRecords | Query error log details | Queries the error log details of an instance within a specified time range. |
DAS Agent
|
API |
Title |
Description |
| Chat | Interact with DAS agent | Invokes the asynchronous logic interface for DAS large model capabilities. |
| GetInstanceGroupInspectReportList | Query DAS agent O&M reports | Queries the list of O&M reports generated by DAS Agent. |
| GetInstanceGroupInspectReportDetail | Query DAS agent operations report details | Retrieves the details of a DAS Agent automated operations report. |
Cross-product whitelist
|
API |
Title |
Description |
| CreateSecurityIPGroup | Create a cross-service whitelist template | Creates a cross-service whitelist template for a user. |
| DescribeSecurityIPGroup | Display cross-engine whitelist template details | Displays the details of a cross-engine whitelist template for a user. |
| DescribeSecurityIPGroupRelation | Display cross-engine whitelist template binding information | Displays the binding information between a cross-engine whitelist template and instances for a user. |
| ModifySecurityIPGroup | ModifySecurityIPGroup | Modifies a cross-product whitelist template. |
| ModifySecurityIPGroupRelation | Attach or detach a cross-engine whitelist template | Attaches or detaches a cross-engine whitelist template to or from a user. |
| DeleteSecurityIPGroup | Delete a cross-product whitelist template | Deletes a cross-product whitelist template for a user. |
Others
|
API |
Title |
Description |
| GetDasAgentSSE | (Deprecated) DAS agent data stream interface | Provides a DAS large model interactive SSE interface. Supports features such as AI chat and performance diagnostics. |
| DescribeSqlLogRecords | DescribeSqlLogRecords | Call DescribeSqlLogRecords to query log details 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 | Query DAS enterprise edition (V1 or V2) storage usage | Queries the storage usage of DAS Enterprise Edition V1 or V2 for a database instance. |
| RunCloudBenchTask | RunCloudBenchTask | Calls the RunCloudBenchTask operation to execute a stress testing task. |
| DescribeCloudbenchTask | Query a stress testing task | Queries a stress testing task. |
| DescribeCloudBenchTasks | Query stress testing task list | Queries the list of 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. |
| GetYaoChiAgent | Call the apsaraDB agent foundation model capability interface | Provides the Alibaba Cloud ApsaraDB Agent foundation model capability interface for AI chat, performance diagnostics, and other features. |
| DescribeAuditLogs | Query audit alert logs | Queries the list of data audit alert logs to facilitate alert search and processing. |
| DescribeDasOpsConfig | View Alibaba Cloud Managed Services configuration | Queries the enabled items of the Alibaba Cloud Managed Services. |
| DescribeSqlInsightStatistic | Query SQL insight statistics | Invokes the DescribeSqlInsightStatistic operation to perform aggregation of SQL Explorer statistics for a specified instance within a given time window by dimensions such as SQL template, access source, or database user. |
| ModifyDasOpsConfig | Enable or disable DAS Alibaba Cloud Managed Services | Modifies the configuration items of Alibaba Cloud Managed Services. |
| ModifyForwardSqlLogConfig | Enable or disable log forwarding delivery | Modifies the audit log forwarding configuration. |