Docs

Database Workshop

Diagnostics and Snapshots

DescribeDialogDetailSnapshot

Call the DescribeDialogDetailSnapshot API to query the details of session information in a session snapshot.

Request type

Synchronous request

Request parameters

Parameter	Type	Is it required?	Sample	Description
InstanceId	String	Yes	mysql-c******	Database instance ID Call the DescribeDBInstances API to query the instance ID of RDS for MySQL. Call the DescribeDBInstances API to query the instance ID of veDB MySQL. Call the DescribeDBInstances API to query the instance ID of RDS for PostgreSQL. Call the DescribeDBInstances API to query the instance ID of Document Database for MongoDB.
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.
PageNumber	Integer	Yes	1	Page number.
PageSize	Integer	Yes	20	Page size.
NodeId	String	No	mysql-c****-0	Database instance node ID.
QueryFilter	QueryFilter	No	{ "ShowSleepConnection":true }	Session snapshot filter criteria.

Response parameters

Parameter	Type	Sample	Description
Total	Integer	100	Total number of session snapshots.
DialogDetails	Array of DialogDetailst	{ "BlockingPid": "", "Command": "Sleep", "DB": "mysql", "Desc": "", "Host": "11.192.56.112:50256", "Info": "NULL", "Namespace": "", "NodeId": "mysql-c******-ma822-0", "PSM": "-", "PlanSummary": "", "ProcessID": "267808", "SnapshotTime": 1782791281, "State": "", "Time": "4s", "User": "test_user" }	Session snapshot details.

Request example

POST /?Action=DescribeDialogDetailSnapshot&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-c******",​
    "SnapshotTime":1782791281,​
    "PageNumber":1,​
    "PageSize":20,​
    "QueryFilter":{​
        "ShowSleepConnection":true​
    }​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "202606301149113CB9F2FE036AB424B75C-d9b210",​
        "Action": "DescribeDialogDetailSnapshot",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "DialogDetails": [​
            {​
                "BlockingPid": "",​
                "Command": "Sleep",​
                "DB": "mysql",​
                "Desc": "",​
                "Host": "11.192.56.112:50256",​
                "Info": "NULL",​
                "Namespace": "",​
                "NodeId": "mysql-c******-ma822-0",​
                "PSM": "-",​
                "PlanSummary": "",​
                "ProcessID": "267808",​
                "SnapshotTime": 1782791281,​
                "State": "",​
                "Time": "4s",​
                "User": "test_user"​
            }​
        ],​
        "Total": 1​
    }​
}​

Error code

For details, refer to Error codes.

Last updated: 2026.09.01 16:59:33