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 referenceCall methodReturn result
Copy page
Download PDFCall method
Return result
Copy pageDownload PDFReturn result
This topic describes the API return results of Database Workshop (DBW).
tip
- An HTTP status code of 200 indicates that the interface request succeeded.
- All non-200 HTTP status codes indicate that the interface request failed. The specific failure message is returned in JSON format.
Return result example
- Return result of the successful request call
- {"ResponseMetadata" : {"RequestId": "d78bbf4e-63a5-4937-ac3c-3767e7eddfbe","Action": "DataConnectInstance","Version": "2018-01-01","Service": "dbw","Region": "cn-beijing"},"Result": {/* 具体业务的返回信息 */"SessionId" : "MTU3MTc4MTIwMjQ1OTc3NDk3Ni8xNTcxNzgxMjA0MzMwNDM4NjU2","DatabaseName": "information_schema"}}
The parameter information returned by the request call is as follows:
- ResponseMetadata and its internal RequestId, Action, Version, Service, and Region are fixed fields. They will be returned as long as an API request is initiated, whether the request succeeds or not.
- RequestId is the unique identifier of an API request. If an anomaly occurs with the API, you can submit a ticket for technical support by providing the ID to locate the problem.
- Result is a fixed field, and the content of this field may vary depending on the product. Refer to the actual return. This field will not be returned when the request call fails.
- In addition to the fixed fields, the rest are fields defined by the specific API. For the fields returned by different APIs, refer to the specific definitions in the API documentation.
- Return result of the failed request call
- {"ResponseMetadata": {"RequestId": "202210141739510101742551810409CE5E","Action": "DataExecCommands","Version": "2018-01-01","Service": "dbw","Region": "cn-beijing","Error": {"Code": "ParamError","Message": "The request processing has failed due to some unknown error, exception or failure."}},"Result": null}
- The Error field will definitely appear when the request call fails. The Error field contains the Code and Message fields, where:
- Code indicates the specific error code. You can first find the reason and solution in the public error code and the error code list corresponding to the current interface, based on the error code.
- Message will give the specific reason for the error. This text may change with business development or experience optimization.
- The Result field is not returned when the request call fails.
Last updated: 2025.10.11 16:24:41
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
