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
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 referenceCall methodRequest structure
Copy page
Download PDFCall method
Request structure
Copy pageDownload PDFRequest structure
This topic introduces the API request structure information of Database Workshop (DBW).
Endpoints
The regions currently opened are shown in the table below.
Region | | RegionId | Endpoints |
China | China (Shanghai) | cn-shanghai | dbw.cn-shanghai.volcengineapi.com |
| China (Beijing) | cn-beijing | dbw.cn-beijing.volcengineapi.com |
| China (Guangzhou) | cn-guangzhou | dbw.cn-guangzhou.volcengineapi.com |
| China (Hong Kong) | cn-hongkong | dbw.cn-hongkong.volcengineapi.com |
Overseas | Asia Pacific (Johor) | ap-southeast-1 | dbw.ap-southeast-1.volcengineapi.com |
| Asia Pacific (Jakarta) | ap-southeast-3 | dbw.ap-southeast-3.volcengineapi.com |
tip
- For latency-sensitive services, it is suggested to specify the Region in the request Header. For details, refer to Common parameters.
- The domain name is the access point of the API and does not represent the region where the product or service is actually provided.
Communication protocol
Both HTTP and HTTPS request communication methods are supported. It is recommended that you use the more secure HTTPS method to send requests.
Request method
The HTTP POST request method is supported. Specifically, the supported Content-Type of POST requests is application/JSON (recommended).
tip
Request parameters
Each API request contains the following two types of parameters:
- Common request parameters: A parameter that is used by every API is a common request parameter. For more details about common request parameters, refer to Common parameters.
- API-specific request parameters: Parameters specific to each API. For more information on the request parameters of each API, refer to the API descriptions in API overview.
Character encoding
UTF-8 encoding is used for all requests.
Last updated: 2026.09.01 16:57:38
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
