Docs
EN
Docs
Console
Sign in
Database Workshop
Document
Database Workshop
Database Workshop
Document
What's new
New feature release notes
Announcement
Transaction and lock snapshot optimization has been deprecated
DBW officially charges for Cache for Redis instance database auditing
DBW announces new O&M read-write and read-only permissions
DBW billing: V2 data auditing & full SQL insights (RDS for MySQL/veDB for MySQL)
DBW now supports personal verified accounts
Overview
What is Database Workshop?
Features
Limits
User roles
Role description
I am the DBW system administrator
I am a DBW Normal user
I am a non-DBW system role
Role to permission mapping
View roles
DBW allowlisted IPs
Billing
Overview
Billing items and prices
MySQL Billing Items and Prices
veDB MySQL Billing items and prices
Billing items and prices (RDS for PostgreSQL)
Redis Billing Items and Prices
Pay-as-you-go
Arrears
Permission management
Primary account permission management
IAM user permission management
Quick start
Getting started with SQL console
Querying a slow log through operation observability
Quick start guide for data change ticket management
Quick start with SQL review tickets
Customize ticket approval workflow
Operation guide
Instance list management (New version)
Data management
Data interaction platform
Introduction to SQL window
Natural language to SQL
Ticket list
Role permission application
Data archiving management
Overview
Variables
Operation and maintenance management
Transactions and locks
Automated operation and maintenance management
Search and analyze SQL logs
Enterpise security
Viewing my permissions
User management
User profile
Personal user management
User group management
Approval workflow
Approval node management
Approval workflow management
Action trail management
SQL execution log management
Operations observability log management
DB AI assistant (DBCopilot)
Knowledge base
Viewing fee information
User guide (RDS for MySQL)
Instance list
Instance list management
Enabling security control
Data management
SQL window
Database management
Logging on to the data interaction platform (RDS for MySQL)
Command operations
Database management
Table management
View management
Trigger management
Stored procedure management
Function management
Event management
Data import and export
Importing table data
Exporting table data
Exporting an SQL result set
Viewing a data import or export task
Deleting a data import or export task
Ticket list
Data change ticket
Creating a regular SQL change ticket
Creating a lock-free data change ticket
Creating a lock-free schema change ticket (OnlineDDL)
Managing data change tickets
SQL review ticket
Creating an SQL review ticket
Managing an SQL review ticket
Clear table tickets
Creating a clear table ticket
Manage clear table tickets
Data cleanup and archiving ticket
Creating a data cleanup and archiving ticket
Managing a data cleanup and archiving ticket
Data import and export ticket
Creating a data import ticket
Creating a full database export ticket
Creating an SQL result set export ticket
Managing import and export tickets
Permission application ticket
Creating an operation permission ticket
Managing permission application tickets
Managing tasks
Operation and maintenance management
Observation and diagnosis
Session management
Session management
SQL throttling management
Log management
Slow log details management
Slow log diagnosis management
Error log management
Database audit management
Spatial analysis management
Transaction and lock management
One-click diagnosis management
SQL insights and auditing management
Monitoring
Monitoring panel management
AutoOps maintenance
Specification scaling management
Storage expansion management
Automatic index creation management
Database inspection management
Enterprise security management
Granting operation permissions for system roles
Security rules
Security rule set management
Security rule management
User guide (veDB for MySQL)
Instance List
Instance list management
Enabling security control
Data management
SQL window
Database management
Logging on to the data interaction platform (veDB for MySQL)
Command operations
Database management
Table management
View management
Trigger management
Stored procedure management
Function management
Event management
Data import and export
Importing table data
Creating a full database export task
Exporting an SQL result set
Viewing a data import or export task
Deleting a data import or export task
Ticket list
Data change ticket
Creating a regular SQL change ticket
Creating a lock-free data change ticket
Creating a lock-free schema change ticket (OnlineDDL)
Managing data change tickets
SQL review ticket
Creating an SQL review ticket
Managing an SQL review ticket
Clear table ticket
Create a clear table ticket
Manage clear table tickets
Data cleanup and archiving ticket
Creating a data cleanup and archiving ticket
Managing a data cleanup and archiving ticket
Data import and export ticket
Creating a data import ticket
Creating a full database export ticket
Creating an SQL result set export ticket
Managing import and export tickets
Permission application ticket
Create an operation permission ticket
Managing permission application tickets
Operation and maintenance management
Observation and diagnosis
Session management
Session management
SQL throttling management
Log management
Slow log details
Slow log diagnosis
Error log management
Database audit management
Performance monitoring management
One-click diagnosis management
Space analysis management
Transaction and lock management
SQL insights and auditing management
AutoOps management
Node specification auto scaling management
Automatic index creation management
Scheduled scaling management
Database inspection management
Enterprise security management
Granting system role operation permissions
Security rules
Security rule set management
Security rule management
User guide (RDS for PostgreSQL)
Instance list
Instance list management
Enabling security control
Data management
SQL window
Logging on to the data interaction platform (RDS for PostgreSQL)
Command operations
Database management
Schema management
Table management
Exporting an SQL result set
Ticket list
Data change ticket
Creating a regular SQL change ticket
Managing data change tickets
SQL review ticket
Creating an SQL review ticket
Managing an SQL review ticket
Permission application ticket
Creating an operation permission ticket
Managing permission application tickets
Operation and maintenance management
Observation and diagnosis
Session management
Log management
Database audit
Spatial analysis management
Performance monitoring management
One-click diagnosis management
SQL insights and auditing management
Transaction and lock management
AutoOps
Storage space expansion management
Database inspection management
Enterprise security management
Granting operation permissions for system roles
Security rules
Security rule set management
Security rule management
User guide (RDS for SQL Server)
Instance list
Instance list management
Enabling security control
Data management
SQL window
Logging on to the data interaction platform (RDS for SQL Server)
Command operations
Ticket management
Permission application ticket
Creating an operation permission ticket
Managing permission application tickets
Operation and maintenance management
Performance monitoring management
Enterprise security management
Granting operation permissions for system roles
Security rules
Security rule set management
Security rule management
User guide (Cache for Redis)
Instance list
Instance list management
Enabling security control
Data management
SQL window
Logging on to the data interaction platform (Cache for Redis)
Command operations
Key value management
Ticket list
Permission application ticket
Creating an operation permission ticket
Managing permission application tickets
Operation and maintenance management
Observation and diagnosis
Performance monitoring management
(Beta) Database audit management
(Beta) Bandwidth auto-scaling management
Database inspection management
Enterprise security management
Granting operation permissions for system roles
User guide (Document Database for MongoDB)
Instance list
Instance list management
Enabling security control
Data management
SQL window
Logging on to the data interaction platform (Document Database for MongoDB)
Command operations
Visual query management
Database management
Collection management
Index management
Ticket management
Permission application ticket
Creating an operation permission ticket
Managing permission application tickets
Data import and export ticket
Creating a data import ticket
Creating a full database export ticket
Managing import and export tickets
Operation and maintenance management
Session management
Spatial analysis management
Performance monitoring management
Enterprise security management
Granting operation permissions for system roles
Security rules
Security rule set management
Security rule management
Developer tools
Volcano Engine DBW NL2SQL service
Best practices
Handling slow SQL issues in the RDS for MySQL database
Analyzing the primary-replica lag issue of RDS for MySQL instances through full SQL insight
Initializing a sub-user as an administrator
How to use the added knowledge base through the AI assistant (DBCopilot)
API reference
API History
API overview
Call method
Request structure
Common parameters
Signature mechanism
Return result
Compliance Agreement
AgreeUserProtocol
Instance access
DataConnectInstance
SQL task
DataExecCommands
DataSessionKeepAlive
DataCloseSession
DataCancelExec
DataExecCommandSetAsync
DataGetCommandSetResult
DataDescribeCommandSet
GenerateSQLFromNL
ExecuteSQL
ListDatabases
ListTables
GetTableInfo
Persistent Kill
CreateSqlKillRule
StopSqlKillRule
DeleteSqlKillRule
DescribeSqlKillRules
Operation and maintenance management
DescribeSlowLogs
ListSlowQueryAdviceApi
SlowQueryAdviceTaskHistoryApi
Ticket management
CreateDmlSqlChangeTicket
CreateDdlSqlChangeTicket
DescribeTickets
DescribeTicketDetail
DescribeWorkflow
WorkflowAction
ManualExecuteTicket
DescribePreCheckDetail
Security control
DescribeSecurityGroups
ListApprovalFlowConfig
ListApprovalNode
DescribeManagedUsers
EnableInstanceManagement
UpdateInstanceManagementConfig
DisableInstanceManagement
Appendixes
Error code
Data structure
FAQ
FAQ Overview
FAQ about permission management
How do I authorize a sub-account to access Database Workshop
Insufficient permissions when logging into the Database Workshop DBW. What should I do?
When encountering an xxxx instance with security control enabled and the current user lacks the [Operation and Maintenance Read-Only] permission, contact the administrator for authorization or apply for the [Operation and Maintenance Read-Only] permission
General FAQ
Which databases does Database Workshop DBW support?
What instance types does the instance list page of Database Workbench DBW support?
What database instances does the Data Interaction Platform feature of Database Workshop DBW support?
What databases does the operation and maintenance management feature of DBW support?
Can I switch to a Cache for Redis account after logging on to the data interaction platform
Can execution results and execution records be exported after executing SQL in the SQL console?
Why is the total number of sessions in the session management tab inconsistent with the number of connections in the MySQL instance?
Why are the time consumption metrics inconsistent across DBW console's full SQL insights, audit logs, and slow logs?
Why is the deadlock time and deadlock count collected on the Transactions and Locks page inconsistent with the performance monitoring collection?
What if the approver cannot approve in time due to certain reasons?
Does modifying the approval process of an instance affect the already generated work orders?
What should I do if I encounter the error OnlineDDLErrorCode_DuplicateKeyOrColumn while executing a lock-free schema change task?
Why can't instances with security control enabled be successfully called via the API interface?
How to resolve the "too many connections" error when executing OnlineDDL?
How to view the historical commit records of a MySQL instance in the cloud database?
Why are not all SQLs recorded in Full SQL Insights?
What should I do if I encounter insufficient permissions when logging into the Data Interaction Platform DBW?
Why can't I find data from the Cache for Redis on the data interaction platform?
Why can't I directly execute Create index or Drop index statements on database tables in the data interaction console?
Does Database Workshop (DBW) support cross-account?
How to resolve the "PrecheckFailed_DiskSpaceInsufficient" error when creating a ticket?
Troubleshooting
What should I do if I receive a session creation failure prompt when logging into an instance on the Data Interaction Platform?
When calling the DBW API, I encountered the error "Client.Timeout exceeded while awaiting headers." What should I do?
What should I do if an error occurs during the session connection when logging into the Redis instance on the Data Interaction Platform?
What to do if you encounter an error during the ticket submission process?
What to do if the connection fails when logging into the data interaction platform?
Terms
Service-Specific Terms for Volcano Engine Database Workshop
Database Workshop_Service Level Agreement
Disclaimer and service terms of natural language to SQL conversion
Documentation
Database Workshop
API reference
Operation and maintenance management
SlowQueryAdviceTaskHistoryApi
Copy page
Operation and maintenance management
SlowQueryAdviceTaskHistoryApi
Copy page
SlowQueryAdviceTaskHistoryApi
Last updated: 2025.10.11 16:26:45