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

Database Workshop

Copy page
Download PDF
Diagnostics and Snapshots
ModifyInstanceDasSnapshotCollectionSwitch
Copy page
Download PDF
ModifyInstanceDasSnapshotCollectionSwitch
Call the ModifyInstanceDasSnapshotCollectionSwitch operation to modify the session snapshot collection feature.​
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.​
DasSnapShotLists​
Array of string​
Yes​
​
[​
"Dialog"​
]​
​
Whether to enable session snapshot collection. The values are as follows:​
  • When the value is set to Dialog, it indicates that session snapshot collection is enabled for the instance.​
  • When the value is set to an empty array, it indicates that session snapshot collection is not enabled for the instance.​
Switch​
Boolean​
Yes​
true​
Whether to enable session snapshot collection. Valid values:​
  • true: Indicates that session snapshot collection is enabled.​
  • false: Indicates that session snapshot collection is disabled.​
warning​
The API takes effect only when DasSnapShotLists is configured as ["Dialog"] and Switch is configured as true.​
RegionId​
String​
Yes​
cn-beijing​
Region ID.​
EnableBackoff​
Boolean​
No​
true​
Specifies whether to enable the backoff strategy. Valid values:​
  • true: (Default) Enables the backoff strategy. After the backoff strategy is enabled, if collection fails due to an instance anomaly, the collection automatically applies the backoff strategy and gradually reduces the collection frequency until it returns to normal.​
  • false: Disables the backoff strategy.​
tip​
This parameter takes effect only when the Switch parameter is set to true.​
​
Response parameters​
​
Name​
Type​
Sample​
Description​
Success​
Boolean​
true​
Modify session snapshot collection. Valid values:​
  • true: Indicates that the session snapshot collection feature is successfully modified.​
  • false: indicates that modifying the session snapshot collection feature failed.​
​
Request example​
​
POST /?Action=ModifyInstanceDasSnapshotCollectionSwitch&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-f3b916bef3c8",​
"InstanceType": "MySQL",​
"RegionId": "cn-beijing",​
"DasSnapShotLists": [​
"Dialog"​
],​
"Switch": true,​
"EnableBackoff": true​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "20261008142104473B3FA7AE1387227552-201086",​
"Action": "ModifyInstanceDasSnapshotCollectionSwitch",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"Success": true​
}​
}​
​
Error code​
For details, refer to Error codes.​
Last updated: 2026.10.14 09:51:11