文档中心

数据库工作台

API参考

API 概览

本文汇总数据库工作台 DBW 提供的 API 接口。

合规协议

API	描述
AgreeUserProtocol	调用 AgreeUserProtocol 接口同意数据库工作台 DBW 的用户协议。

实例接入

API	描述
DataConnectInstance	调用 DataConnectInstance 接口连接实例。

SQL 任务

API	描述
DataExecCommands	调用 DataExecCommands 接口同步执行命令集。
DataSessionKeepAlive	调用 DataSessionKeepAlive 接口保持 SQL 会话窗口。
DataCloseSession	调用 DataCloseSession 接口退出 SQL 会话窗口。
DataCancelExec	调用 DataCancelExec 接口取消 SQL 执行。
DataExecCommandSetAsync	调用 DataExecCommandSetAsync 接口异步执行命令集。
DataGetCommandSetResult	调用 DataGetCommandSetResult 接口查询异步执行命令集的执行结果。
DataDescribeCommandSet	调用 DataDescribeCommandSet 接口查询命令集的执行状态。
GenerateSQLFromNL	调用 GenerateSQLFromNL 接口将自然语言生成 SQL 语句。
ExecuteSQL	调用 ExecuteSQL 接口执行 SQL 语句。
ListDatabases	调用 ListDatabases 接口查询数据库实例的数据库列表。
ListTables	调用 ListTables 接口查询数据库实例的数据库中的表列表。
GetTableInfo	调用 GetTableInfo 接口查询数据库实例的表元信息。

持续 Kill

API	描述
CreateSqlKillRule	调用 CreateSqlKillRule 接口创建持续 Kill 任务。
StopSqlKillRule	调用 StopSqlKillRule 接口停止持续 Kill 任务。
DeleteSqlKillRule	调用 DeleteSqlKillRule 接口删除持续 Kill 任务。
DescribeSqlKillRules	调用 DescribeSqlKillRules 接口查询持续 Kill 任务。

运维管理

API			描述
SQL 限流	DescribeSqlKeywords	调用 DescribeSqlKeywords 接口根据原始 SQL 语句生成 SQL 限流关键字。
		CreateSqlConcurrencyControlRule	调用 CreateSqlConcurrencyControlRule 接口创建 SQL 限流任务。
		DescribeSqlConcurrencyControlRules	调用 DescribeSqlConcurrencyControlRules 接口查询数据库实例的所有 SQL 限流任务。
		StopSqlConcurrencyControlRule	调用 StopSqlConcurrencyControlRule 接口停止 SQL 限流任务。
		RestartSqlConcurrencyControlRule	调用 RestartSqlConcurrencyControlRule 接口启用暂停的 SQL 限流任务。
		DeleteSqlConcurrencyControlRule	调用 DeleteSqlConcurrencyControlRule 接口删除 SQL 限流任务。
审计日志管理	DescribeAuditLogDetail	调用 DescribeAuditLogDetail 接口查询审计日志的详细信息。
慢日志与优化建议	DescribeSlowLogs	调用 DescribeSlowLogs 接口查询慢日志信息。
		DescribeAggregateSlowLogs	调用 DescribeAggregateSlowLogs 接口获取慢日志的聚合信息。
		ListSlowQueryAdviceApi	调用 ListSlowQueryAdviceApi 接口获取慢日志诊断详情信息。
		SlowQueryAdviceTaskHistoryApi	调用 SlowQueryAdviceTaskHistoryApi 接口获取慢日志诊断历史信息。
诊断与快照	DescribeDialogDetailSnapshot	调用 DescribeDialogDetailSnapshot 接口查询会话快照会话信息详情。
		DescribeDialogSnapshots	调用 DescribeDialogSnapshots 接口查询会话快照的时间点列表。
		DescribeEngineStatusSnapShot	调用 DescribeEngineStatusSnapShot 接口查询会话快照引擎状态信息详情。
		DescribeInstanceDasSnapShotCollectionStatus	调用 DescribeInstanceDasSnapShotCollectionStatus 接口查询指定数据库实例的会话快照采集状态和退避策略状态。
		ModifyInstanceDasSnapshotCollectionSwitch	调用 ModifyInstanceDasSnapshotCollectionSwitch 接口修改会话快照采集功能。
SQL 洞察与审计	PreCheckCreateFullSql	调用 PreCheckCreateFullSql 接口开启全量 SQL 洞察。
		CreateTerminateFullSqlOrder	调用 CreateTerminateFullSqlOrder 接口为指定全量 SQL 实例创建退订订单。
		CreateFullSqlOrder	调用 CreateFullSqlOrder 接口为指定实例创建全量 SQL 订阅订单。
		GetFullSqlInstanceCorrespondence	调用 GetFullSqlInstanceCorrespondence 接口查询 FullSQL 的实例映射关系。
		DescribeFullSqlStatus	调用 DescribeFullSqlStatus 接口查询指定实例的全量 SQL 开通状态、功能状态和订阅配置。
		DescribeFullSQLFingerprintExample	调用 DescribeFullSQLFingerprintExample 接口根据 SQL 指纹查询全量 SQL 明细样例。
		DescribeSqlTemplatesContrast	调用 DescribeSqlTemplatesContrast 接口查询两个时间段内全量 SQL 模板的聚合指标对比。
		DescribeSQLExecItemMetric	调用 DescribeSQLExecItemMetric 接口查询某个 SQL 指纹在指定时间范围内的单项执行指标曲线。
自动运维	AutoScale	调用 AutoScale 接口配置扩缩容规则。
		DescribeAutoScaleEvents	调用 DescribeAutoScaleEvents 接口查询指定实例的扩缩容事件。
		DescribeAutoScaleRules	调用 DescribeAutoScaleRules 接口查询实例自动或定时扩缩容配置。

工单管理

API	描述
CreateDmlSqlChangeTicket	调用 CreateDmlSqlChangeTicket 接口创建 DML 数据变更工单。
CreateDdlSqlChangeTicket	调用 CreateDdlSqlChangeTicket 接口创建 DDL 结构变更工单。
DescribeTickets	调用 DescribeTickets 接口批量查询工单。
DescribeTicketDetail	调用 DescribeTicketDetail 接口查询单个工单详情。
DescribeWorkflow	调用 DescribeWorkflow 接口查询审批工单详情。
WorkflowAction	调用 WorkflowAction 接口审批工单。
ManualExecuteTicket	调用 ManualExecuteTicket 接口手动执行工单。
DescribePreCheckDetail	调用 DescribePreCheckDetail 接口查询工单的预检查结果。

安全管控

API	描述
DescribeSecurityGroups	调用 DescribeSecurityGroups 接口查询安全规则集。
ListApprovalFlowConfig	调用 ListApprovalFlowConfig 接口查询审批流程列表。
ListApprovalNode	调用 ListApprovalNode 接口查询审批节点。
DescribeManagedUsers	调用 DescribeManagedUsers 接口查询用户信息。
EnableInstanceManagement	调用 EnableInstanceManagement 接口为数据库实例开启安全管控。
UpdateInstanceManagementConfig	调用 UpdateInstanceManagementConfig 接口修改安全管控信息。
DisableInstanceManagement	调用 DisableInstanceManagement 接口关闭安全管控。

最近更新时间：2026.10.10 10:39:17

这个页面对您有帮助吗？

有用

无用