1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
查询实例的死锁事件列表
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDeadLockLogs。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Product | 是 | String | 服务产品类型。取值:sqlserver(云数据库 Sqlserver)。 示例值:sqlserver |
| InstanceId | 是 | String | 实例 ID。SQLServer: mssql-xxxx。 示例值:mssql-15rso1sb |
| StartTime | 是 | String | 查询开始时间,格式 yyyy-MM-dd HH:mm:ss,按 UTC+8 解析;也兼容带偏移的 ISO-8601(如 2026-09-16T00:00:00+08:00)。半开区间左闭。 参数格式:2026-09-16 00:00:00 示例值:2026-09-18 14:50:00 |
| EndTime | 是 | String | 查询结束时间,格式同 StartTime。EndTime 必须大于 StartTime,且总查询窗口不超过 24 小时。半开区间右开。 参数格式:2026-09-16 23:59:59 示例值:2026-09-18 23:59:59 |
| Offset | 否 | Integer | 分页偏移量,非负整数,默认 0。当 Offset>0 时必须同时传入 ResultVersion,否则报 INVALID_PARAMETER。 示例值:0 |
| Limit | 否 | Integer | 单页返回死锁事件数量,范围 [1, 100]。默认 20。 示例值:10 |
| IncludeXml | 否 | Boolean | 是否在响应中包含原始死锁图 XML(XmlReport)。默认 false,避免响应体过大。仅在需要绘制完整死锁环时置 true。 示例值:true |
| ResultVersion | 否 | String | 结果集版本号,最大 128 字符。首次查询无需传入;翻页时必须透传首次响应中的 ResultVersion,服务端会校验结果集是否发生变化,变化时返回 RESULT_CHANGED 提示重新拉取首页。 示例值:0587b3cf0a28da7cdd93e6ecb1c1f5bc850805d6e506ccadc31b0f18ef144f81 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HasMore | Boolean | 是否还有更多分页。true 表示 Offset+Limit < TotalCount,客户端可用 Offset+Limit 与本次 ResultVersion 继续翻页。 示例值:false |
| TotalCount | Integer | 当前查询窗口内可用的死锁事件总数(去重、关联、时间窗口过滤后)。 示例值:8 |
| ResultVersion | String | 结果集版本号(SHA-256 十六进制)。同一批数据在同一查询条件下保持不变;数据发生变化时版本变化。翻页必须透传。 示例值:8cc6fd1f70a2dfbdaa69b590f5daab353a98c959fb24a9d342df483b550ec796 |
| Items | Array of DeadLockLogItem | 死锁事件列表。按事件时间倒序排列(最近的死锁在前)。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询死锁日志
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeadLockLogs
<公共请求参数>
{
"Product": "sqlserver",
"InstanceId": "mssql-15rso1sb",
"StartTime": "2026-09-18 14:50:00",
"EndTime": "2026-09-18 23:59:59"
}
输出示例
{
"Response": {
"HasMore": false,
"TotalCount": 8,
"Items": [
{
"InstanceId": "mssql-15rso1sb",
"TimestampSource": "OBSERVED_LOG",
"PartialReasonCode": "XML_NOT_AVAILABLE",
"VictimProcessIds": [],
"PayloadTruncated": false,
"SourceUuids": [
"7ebe128e-fb90-4f2b-af4c-abc62336e478"
],
"ObservedTransactionCount": 2,
"GraphStatus": "MISSING",
"XmlIncluded": false,
"ProcessCount": 2,
"Transactions": [
{
"Status": "Unknown",
"Sessions": [
{
"SqlFingerprint": null,
"LoginName": "sa",
"Frames": [],
"IsolationLevel": null,
"ProcessStatus": null,
"ClientApp": null,
"Priority": null,
"DatabaseName": null,
"LockHold": [],
"SqlText": null,
"Host": "30.101.245.168",
"DatabaseId": 11,
"IsVictim": null,
"WaitTimeMs": null,
"ExecutionContextId": null,
"LastTransStarted": null,
"ProcessId": null,
"ClientAppNormalized": null,
"LockRequest": [],
"SessionId": 61
}
],
"IsVictim": null,
"TransactionId": "170329108"
}
],
"DeadlockId": "75789",
"XmlReport": "",
"OriginalXmlBytes": null,
"EventTimestamp": "2026-09-18T09:43:41.5434049+00:00",
"VictimSessionIds": [
83
],
"IsPartial": true,
"DatabaseNames": [
"test_lock"
],
"EventId": "partial:7ebe128e-fb90-4f2b-af4c-abc62336e478",
"DeadlockSignature": "",
"Resources": [],
"AssociationStatus": "UNMATCHED",
"TransactionCount": 2
}
],
"ResultVersion": "8cc6fd1f70a2dfbdaa69b590f5daab353a98c959fb24a9d342df483b550ec796",
"RequestId": "13890fe3-ff26-419e-8b11-78b829cfa9c5"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AuditNotOpened | 实例审计未开启 |
| FailedOperation.SegmentLoading | 数据加载中 |
| InternalError | 内部错误。 |
| InternalError.DbOperationFailed | 数据库操作失败 |
| InternalError.InternalError | InternalError.InternalError |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.HasDuplicatedTask | 该时间范围内的审计日志已下载 |