You need to enable JavaScript to run this app.
Database Workshop

Database Workshop

Copy page
Download PDF
Diagnostics and Snapshots
DescribeEngineStatusSnapShot
Copy page
Download PDF
DescribeEngineStatusSnapShot
Call the DescribeEngineStatusSnapShot API to query session snapshot engine status details.​
Request type​
Synchronous request​
Request parameters​
​
Parameter​
Type​
Is it required?​
Sample​
Description​
InstanceId​
​
String​
​
Yes​
mysql-c******​
Database instance ID​
DSType​
String​
Yes​
MySQL​
Database types. The following database types are supported:​
  • MySQL: RDS for MySQL.​
  • VeDBMySQL: veDB for MySQL.​
  • Postgres: RDS for PostgreSQL.​
  • Mongo: Document Database for MongoDB.​
SnapshotTime​
Integer​
Yes​
1782349500​
Session snapshot timestamp in seconds.​
NodeId​
String​
Yes​
mysql-bf120f******​
Database instance node ID.​
​
Response parameters​
​
Parameter​
Type​
Sample​
Description​
Type​
String​
InnoDB​
Engine type.​
Status​
String​
\n=====================================\n2026-06-25 16:02:48 140562380879616 INNODB MONITOR OUTPUT\n​
Engine status details.​
NodeId​
String​
mysql-c28c25******-ma822-0​
Database instance node ID.​
​
Request example​
​
POST /?Action=DescribeEngineStatusSnapShot&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****​
​
{​
"DSType":"MySQL",​
"InstanceId":"mysql-c28c25******",​
"SnapshotTime":1782791281,​
"NodeId": "mysql-c28c25******-ma822-0"​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "202606301505382254CF3000D4BF35878A-2bfb68",​
"Action": "DescribeEngineStatusSnapShot",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"Name": "",​
"NodeId": "mysql-c28c25******-ma822-0",​
"Status": "\n=====================================\n2026-06-25 16:02:48 140562380879616 INNODB MONITOR OUTPUT\n",​
"Type": "InnoDB"​
}​
}​
​
Error code​
For details, refer to Error codes.​
Last updated: 2026.09.01 16:59:33