Database Workshop
Database Workshop
Database Workshop
Document
What's new
Announcement
Overview
Billing
Permission management
Quick start
Operation guide
Data management
Data interaction platform
Ticket list
Operation and maintenance management
Enterpise security
Approval workflow
Action trail management
User guide (RDS for MySQL)
Instance list
Data management
SQL window
Database management
Ticket list
Data change ticket
SQL review ticket
Clear table tickets
Data cleanup and archiving ticket
Data import and export ticket
Permission application ticket
Operation and maintenance management
Observation and diagnosis
Session management
Monitoring
Enterprise security management
User guide (veDB for MySQL)
Instance List
Data management
SQL window
Database management
Ticket list
Data change ticket
SQL review ticket
Clear table ticket
Data cleanup and archiving ticket
Data import and export ticket
Permission application ticket
Operation and maintenance management
Observation and diagnosis
Session management
Log management
Enterprise security management
User guide (RDS for PostgreSQL)
Instance list
Data management
SQL window
Ticket list
Data change ticket
SQL review ticket
Permission application ticket
Operation and maintenance management
Enterprise security management
User guide (RDS for SQL Server)
Instance list
Data management
Ticket management
Permission application ticket
Operation and maintenance management
Enterprise security management
User guide (Cache for Redis)
Instance list
Data management
SQL window
Ticket list
Permission application ticket
Operation and maintenance management
Enterprise security management
User guide (Document Database for MongoDB)
Instance list
Data management
SQL window
Ticket management
Permission application ticket
Operation and maintenance management
Enterprise security management
User guide (External instance user guide)
Developer tools
Best practices
API reference
Compliance Agreement
Instance access
SQL task
Operation and maintenance management
SQL throttling
Audit log management
Slow log and optimization suggestions
Diagnostics and Snapshots
SQL insights and auditing
Ticket management
Security control
Appendixes
FAQ
FAQ about permission management
Troubleshooting
- Documentation
Database WorkshopAPI referenceOperation and maintenance managementSQL throttlingDescribeSqlKeywords
Copy page
Download PDFSQL throttling
DescribeSqlKeywords
Copy pageDownload PDFDescribeSqlKeywords
Call the DescribeSqlKeywords API to generate SQL throttling keywords based on the original SQL statement.
Request type
Synchronous request
Request parameters
Name | Type | Is it required? | Sample | Description |
InstanceId | String | Yes | mysql-383906****** | Database instance ID
|
InstanceType | String | Yes | MySQL | Database types. The following database types are supported:
|
RegionId | String | Yes | cn-beijing | Region ID. |
Sql | String | Yes | select * from test | Sample of the original SQL statement. |
Response parameters
Name | Type | Sample | Description |
KeyWords | String | select~from~test | SQL keywords. |
Request example
POST /?Action=DescribeSqlKeywords&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: dbw.cn-beijing.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"Sql": "select * from test",
"InstanceType": "MySQL",
"InstanceId": "mysql-383906******",
"RegionId": "cn-beijing"
}
Response example
{
"ResponseMetadata": {
"RequestId": "20261008151202094E295FA0449BF29C8F-6ea562",
"Action": "DescribeSqlKeywords",
"Version": "2018-01-01",
"Service": "dbw",
"Region": "cn-beijing"
},
"Result": {
"KeyWords": "select~from~test"
}
}
Error code
Last updated: 2026.10.14 09:51:11
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
