All Products
Search
Document Center

:List of operations by function

Last Updated:Jul 25, 2023

The following tables list the API operations available for use in Database Autonomy Service (DAS).

Instance connection

Operation

Description

AddHDMInstance

Adds a database instance.

SQL throttling

Operation

Description

EnableSqlConcurrencyControl

Controls the number of database access requests and concurrent SQL requests.

DisableSqlConcurrencyControl

Disables a throttling rule.

DisableAllSqlConcurrencyControlRules

Disables all throttling rules that are in effect.

GetRunningSqlConcurrencyControlRules

Queries the throttling rules that are in effect.

GetSqlConcurrencyControlRulesHistory

Queries the throttling rules that were triggered or the throttling rules that are in effect.

GetSqlConcurrencyControlKeywordsFromSqlText

Generates a throttling keyword string based on an SQL statement.

SQL diagnostics

Operation

Description

CreateRequestDiagnosis

Initiates a request for SQL diagnostics on a database instance connected to DAS.

GetRequestDiagnosisPage

Queries SQL diagnostics history on multiple pages.

GetRequestDiagnosisResult

Queries the results of an SQL diagnostics task.

Intelligent stress testing

Operation

Description

DescribeCloudBenchTasks

Queries the information about stress testing tasks.

DescribeCloudbenchTask

Queries the information about a stress testing task.

DescribeCloudbenchTaskConfig

Queries the configurations of a stress testing task.

RunCloudBenchTask

Runs a stress testing task.

CreateCloudBenchTasks

Creates a stress testing task.

DeleteCloudBenchTask

Deletes a stress testing task.

StopCloudBenchTask

Stops a stress testing task.

CreateAdamBenchTask

Creates a stress testing task on Advanced Database & Application Migration (ADAM).

DeleteStopGateway

Deletes the metadata of stopped database gateways.

Diagnostics reports

Operation

Description

CreateDiagnosticReport

Creates a diagnostics report.

DescribeDiagnosticReportList

Queries the information about diagnostics reports.

Automatic SQL optimization

Operation

Description

GetSqlOptimizeAdvice

Queries the SQL optimization suggestions that are generated by DAS.

UpdateAutoSqlOptimizeStatus

Enables, modifies, or disables the automatic SQL optimization feature for multiple database instances at a time.

GetInstanceSqlOptimizeStatistic

Collects statistics on automatic SQL optimization tasks within a period of time, such as the total number of tasks and maximum improvement.

Cache analysis

Operation

Description

CreateCacheAnalysisJob

Creates a cache analysis task.

DescribeCacheAnalysisJob

Queries the information about a cache analysis task.

DescribeCacheAnalysisJobs

Queries the information about cache analysis tasks.

Inspection and scoring

Operation

Description

GetInstanceInspections

Queries the inspection and scoring results of database instances.

Event notification

Operation

Description

SetEventSubscription

Configures the event subscription settings of a database instance.

GetEventSubscription

Queries the event subscription settings of a database instance.

GetAutonomousNotifyEventContent

Queries the content of a notification event.

GetAutonomousNotifyEventsInRange

Queries notification events based on a severity level.

Hot key management for ApsaraDB for Redis instances

Operation

Description

DescribeHotKeys

Queries hot keys in an ApsaraDB for Redis instance.

DescribeHotBigKeys

Queries hot keys and large keys in the memory of an ApsaraDB for Redis instance.

DescribeTopHotKeys

Queries the top 20 hot keys within a period of time.

DescribeTopBigKeys

Queries the top 20 large keys within a period of time.

Query governance

Operation

Description

GetQueryOptimizeExecErrorStats

Queries SQL templates that fail to be executed.

GetQueryOptimizeExecErrorSample

Queries the failed SQL statements in an SQL template.

GetQueryOptimizeSolution

Queries the suggestions provided by query governance to optimize an SQL template.

GetQueryOptimizeRuleList

Queries the information about tags added by query governance to slow queries in database instances.

GetQueryOptimizeDataTrend

Queries the trend data of query governance.

GetQueryOptimizeDataTop

Queries the information about the best-performing and worst-performing database instances based on query governance data.

GetQueryOptimizeDataStats

Queries the information about SQL templates based on query governance data.

CreateQueryOptimizeTag

Adds one or more tags to an SQL template.

GetQueryOptimizeTag

Queries the tags of an SQL template.

GetQueryOptimizeShareUrl

Queries the sharing URL of query governance.

SQL Explorer

Operation

Description

GetAsyncErrorRequestStatByCode

Asynchronously queries the MySQL error codes in the SQL Explorer data of a database instance and the number of SQL queries corresponding to each error code.

GetAsyncErrorRequestStatResult

Asynchronously queries the number of failed executions of SQL templates in the SQL Explorer data of a database instance.

GetAsyncErrorRequestListByCode

Asynchronously queries the IDs of SQL queries that generate a MySQL error code in the SQL Explorer data of a database instance.

GetErrorRequestSample

Asynchronously queries the SQL sample data of up to 20 failed SQL queries in the SQL Explorer data of a database instance.

GetFullRequestOriginStatByInstanceId

Queries the full request data by access source in the SQL Explorer data of a database instance.

GetFullRequestStatResultByInstanceId

Asynchronously queries the full request data by SQL ID in the SQL Explorer data of a database instance.

GetFullRequestSampleByInstanceId

Queries the SQL sample data of up to 20 SQL queries by SQL ID in the SQL Explorer data of a database instance.

GetDasSQLLogHotDat

Queries the hot storage data for the new version of the SQL Explorer and Audit feature of a database instance within the last seven days.

DAS Professional Edition management

Operation

Description

EnableDasPro

Enables DAS Professional Edition for a database instance.

DisableDasPro

Disables DAS Professional Edition for a database instance.

GetDasProServiceUsage

Queries the storage usage of the SQL Explorer data of a database instance.

DescribeInstanceDasPro

Queries whether DAS Professional Edition is enabled for a database instance.

Session management

Operation

Description

GetRedisAllSession

Queries the data of the current session on an ApsaraDB for Redis instance.

KillInstanceAllSession

Terminates all sessions of an ApsaraDB for Redis instance.

CreateKillInstanceSessionTask

Creates a task that terminates the sessions of a database instance.

GetKillInstanceSessionTaskResult

Queries the results of a task that terminates the sessions of a database instance.

GetMySQLAllSessionAsync

Asynchronously queries the sessions of a database instance and collects statistics on the sessions from different dimensions.

Automatic SQL throttling

Operation

Description

UpdateAutoThrottleRulesAsync

Asynchronously specifies the parameters of automatic SQL throttling for multiple database instances at a time.

GetAutoThrottleRules

Queries the automatic SQL throttling rules of database instances.

DisableAutoThrottleRules

Disables the automatic SQL throttling feature for multiple database instances at a time.

Automatic tablespace optimization

Operation

Description

UpdateAutoResourceOptimizeRulesAsync

Asynchronously specifies the parameters of the automatic tablespace fragment recycling feature for multiple database instances at a time.

GetAutoResourceOptimizeRules

Queries the automatic tablespace fragment recycling rules of database instances.

DisableAutoResourceOptimizeRules

Disables the automatic tablespace fragment recycling feature for multiple database instances at a time.

Auto scaling

Operation

Description

ModifyAutoScalingConfig

Modifies the auto scaling configurations of a database instance.

DescribeAutoScalingConfig

Queries the auto scaling configurations of a database instance.

DisableInstanceDasConfig

Disables the auto scaling feature for a database instance.

Heatmap

Operation

Description

GetPartitionsHeatmap

Queries the access frequencies and hot data on the partitions of a PolarDB-X 2.0 instance.

Performance insight (new version)

Operation

Description

GetPfsSqlSample

Queries the SQL sample data for the new version of the performance insight feature of a database instance.

GetPfsMetricTrends

Queries the trend of a metric for the new version of the performance insight feature of a database instance.

GetPfsSqlSummaries

Queries the full request data by SQL ID for the new version of the performance insight feature of a database instance.