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

Database Workshop

Copy page
Download PDF
Diagnostics and Snapshots
DescribeInstanceDasSnapShotCollectionStatus
Copy page
Download PDF
DescribeInstanceDasSnapShotCollectionStatus
Call the DescribeInstanceDasSnapShotCollectionStatus API to query the session snapshot collection state and backoff strategy state of the specified database instance.​
Request type​
Synchronous request​
Request parameters​
​
Name​
Type​
Is it required?​
Sample​
Description​
InstanceId​
String​
Yes​
mysql-f3b91*********​
​
Database instance ID​
InstanceType​
​
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.​
RegionId​
String​
Yes​
cn-beijing​
Region ID.​
​
Response parameters​
​
Name​
Type​
Sample​
Description​
DasSnapShotLists​
Array of string​
​
[​
"Dialog"​
]​
​
Whether to enable session snapshot collection. The values are as follows:​
  • When the value is Dialog, it indicates that session snapshot collection is enabled for the instance.​
  • When the value is an empty array, it indicates that session snapshot collection is not enabled for the instance.​
EnableBackoff​
​
Boolean​
true​
Whether to enable the backoff strategy. Valid values:​
  • true: indicates that the backoff strategy is enabled.​
  • false: indicates that the backoff strategy is not enabled.​
​
Request example​
​
POST /?Action=DescribeInstanceDasSnapShotCollectionStatus&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****​
​
{​
"InstanceId": "mysql-f3b91******",​
"InstanceType": "MySQL",​
"RegionId": "cn-beijing"​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "20261008142104473B3FA7AE1387227555-9df2a4",​
"Action": "DescribeInstanceDasSnapShotCollectionStatus",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"DasSnapShotLists": [​
"Dialog"​
],​
"EnableBackoff": true​
}​
}​
​
Error code​
For details, refer to Error codes.​
Last updated: 2026.10.14 09:51:11