This product(
DAS/2020-01-16) 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 (78410016550) 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.
Connect to instances
| API | Title | Description |
|---|---|---|
| AddHDMInstance | AddHDMInstance | Adds 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 | 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. |
Intelligent stress testing
| API | Title | Description |
|---|---|---|
| CreateCloudBenchTasks | CreateCloudBenchTasks | Creates stress testing tasks. |
| RunCloudBenchTask | RunCloudBenchTask | Runs a stress testing task. |
| DeleteCloudBenchTask | DeleteCloudBenchTask | Deletes a stress testing task. |
| DeleteStopGateway | DeleteStopGateway | Deletes the metadata of a stopped DBGateway. |
| DescribeCloudbenchTaskConfig | DescribeCloudbenchTaskConfig | Queries the configurations of a stress testing task. |
| DescribeCloudbenchTask | DescribeCloudbenchTask | Queries a stress testing task. |
| DescribeCloudBenchTasks | DescribeCloudBenchTasks | Queries stress testing tasks. |
Key analysis
| API | Title | Description |
|---|---|---|
| DescribeHotBigKeys | DescribeHotBigKeys | Queries the hot keys and the large keys in the memory in real time. |
| DescribeTopHotKeys | DescribeTopHotKeys | Queries the top 100 hotkeys over a period of time. |
| DescribeTopBigKeys | DescribeTopBigKeys | Queries the top 100 large keys over a period of time. |
| DescribeHotKeys | DescribeHotKeys | Queries the hot keys of an ApsaraDB for Redis instance. |
Query governance
| 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 | Asynchronously obtains the number of failed executions of SQL templates based on SQL Explorer data. |
| 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. |
Manage DAS professional edition
| API | Title | Description |
|---|---|---|
| DescribeSqlLogConfig | DescribeSqlLogConfig | Queries the configurations of Database Autonomy Service (DAS) Enterprise Edition that is enabled for a database instance. |
| ModifySqlLogConfig | ModifySqlLogConfig | Enables or configures Database Autonomy Service (DAS) Enterprise Edition for a database instance. |
| DescribeSqlLogStatistic | DescribeSqlLogStatistic | Queries the statistics of Database Autonomy Service (DAS) Enterprise Edition. |
| GetDasSQLLogHotData | GetDasSQLLogHotData | Queries the hot data of audit logs. |
| CreateSqlLogTask | CreateSqlLogTask | Creates an offline task for Database Autonomy Service (DAS) Enterprise Edition. |
| DescribeSqlLogTask | DescribeSqlLogTask | Queries the details of an offline task in Database Autonomy Service (DAS) Enterprise Edition. |
| DescribeSqlLogTasks | DescribeSqlLogTasks | Queries the audit log tasks of a database instance. |
Session management
| 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. |
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. |
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. |
Index diagnosis
| API | Title | Description |
|---|---|---|
| GetInstanceMissingIndexList | GetInstanceMissingIndexList | Queries the details of all missing indexes of an instance. |
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 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. |
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. |
Heatmap
| API | Title | Description |
|---|---|---|
| GetPartitionsHeatmap | GetPartitionsHeatmap | Queries access frequency statistics and hot data on partitions of a PolarDB-X 2.0 instance. |
New performance insight
| 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. |
Other
| API | Title | Description |
|---|---|---|
| DescribeSqlLogRecords | DescribeSqlLogRecords | Queries the log details of a database instance for which Database Autonomy Service (DAS) Enterprise Edition is enabled. |
| 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. |