1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
根据指定快照 token 查询该快照时刻的完整阻塞树(多层嵌套,根节点为头 blocker,支持多叉/多层展开)。支持两种定位方式,任选其一:(1) 优先 MonitorLoop(精确,lock monitor 一次扫描快照的唯一标识),可从 DescribeBlockingTimeRange / DescribeBlockingLogs / DescribeBlockingTrend 返回获取;(2) 兑底 BlockingTime(近似,任意阻塞时间点),后端会在该时间点±1分钟范围内找到最接近的 MonitorLoop 再下钻其阻塞树。当 MonitorLoop 不为空时优先采用;为空时回退使用 BlockingTime;两者都为空则返回参数错误。一个 MonitorLoop 可包含多棵独立阻塞树(若该快照内存在多组互不相干的阻塞链路)。对标 dbaas-pfs 的 DescribeLockTree。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBlockingLockTree。 |
| Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID。 示例值:mssql-15rso1sb |
| Product | 是 | String | 服务产品类型,固定为sqlserver。 示例值:sqlserver |
| MonitorLoop | 否 | String | lock monitor 扫描轮次 ID(可从 DescribeBlockingTimeRange 返回的 MonitorLoops 列表选择,也可从 DescribeBlockingLogs / DescribeBlockingTrees 返回的 MonitorLoop 字段获取)。与 BlockingTime 二选一,MonitorLoop 优先。 示例值:1000782 |
| BlockingTime | 否 | String | 阻塞时间点,格式:yyyy-MM-dd HH:mm:ss。当 MonitorLoop 为空时使用该字段定位:后端会在该时间点±1分钟范围内寻找最接近的 MonitorLoop 并下钻其阻塞树。与 MonitorLoop 二选一。BlockingTime 必须在最近 30 天内,否则返回 InvalidParameterValue。 示例值:2026-10-19 20:15:32 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of BlockingChainTree | 阻塞树列表(同一 MonitorLoop 下可能存在多棵独立阻塞树,按链路影响时长倒序)。若按 BlockingTime 定位时未找到附近 MonitorLoop,返回空列表。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询某时间点的阻塞会话树
查询某时间点的阻塞会话树
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlockingLockTree
<公共请求参数>
{
"InstanceId": "mssql-15rso1sb",
"MonitorLoop": "1000782",
"Product": "sqlserver"
}
输出示例
{
"Response": {
"Items": [
{
"BlockingStatus": "suspended",
"BlockingClientApp": "python-pymssql",
"DurationMs": 8342,
"EndTime": "2026-10-21 21:05:33",
"BlockingSqlMd5": "d4b1ea0c9f6e17bbc45ec3495486aa88",
"BlockingSessionId": 582,
"DatabaseName": "Monitor",
"RootCauseDesc": "长查询正常运行阻塞,考虑优化 SQL/索引",
"StartTime": "2026-10-21 21:05:33",
"BlockingIsolationLevel": "read committed (2)",
"BlockingTransactionId": 715360384,
"ChainDepth": 9,
"BlockingTranCount": 2,
"BlockingWaitTimeMs": 0,
"BlockingSqlTemplate": "EXEC DBO.SP_LONG_LOCK_HOLDER @HOLD_MINUTES = ?",
"MonitorLoop": "1000782",
"Details": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 715360384,
"BlockedWaitTimeMs": 8342,
"BlockedInputBuffer": "UPDATE DBO.ORDER_TABLE SET STATUS = 'DONE' WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "report_svc",
"BlockedClientApp": "python-pymssql",
"BlockedSqlMd5": "7d944d41c2e6dabe7a888207c073288d",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:05",
"BlockedSqlTemplate": "UPDATE DBO.ORDER_TABLE SET STATUS = ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "serializable (4)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 824994255,
"BlockedWaitTimeMs": 8274,
"BlockedInputBuffer": "UPDATE DBO.T_KEY SET V = V + 1 WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "test_g",
"BlockedClientApp": ".Net SqlClient Data Provider",
"BlockedSqlMd5": "800207e64961b44b4abf0152e1260cf6",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:09",
"BlockedSqlTemplate": "UPDATE DBO.T_KEY SET V = V + ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "repeatable read (3)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 653057905,
"BlockedWaitTimeMs": 8280,
"BlockedInputBuffer": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + 1 WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "app_user",
"BlockedClientApp": "jdbc-mssql",
"BlockedSqlMd5": "85db6335df7303b20445750457f23fec",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:18",
"BlockedSqlTemplate": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "repeatable read (3)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 763820642,
"BlockedWaitTimeMs": 8251,
"BlockedInputBuffer": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + 1 WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "app_user",
"BlockedClientApp": "jdbc-mssql",
"BlockedSqlMd5": "85db6335df7303b20445750457f23fec",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:19",
"BlockedSqlTemplate": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "serializable (4)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 551470879,
"BlockedWaitTimeMs": 8220,
"BlockedInputBuffer": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + 1 WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "test_g",
"BlockedClientApp": "python-pymssql",
"BlockedSqlMd5": "85db6335df7303b20445750457f23fec",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:23",
"BlockedSqlTemplate": "UPDATE DBO.ORDER_TABLE SET AMOUNT = AMOUNT + ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "read committed (2)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 594766386,
"BlockedWaitTimeMs": 7906,
"BlockedInputBuffer": "UPDATE DBO.T_KEY SET V = V + 1 WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "test_g",
"BlockedClientApp": "python-pymssql",
"BlockedSqlMd5": "800207e64961b44b4abf0152e1260cf6",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:21",
"BlockedSqlTemplate": "UPDATE DBO.T_KEY SET V = V + ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "repeatable read (3)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 778620777,
"BlockedWaitTimeMs": 8269,
"BlockedInputBuffer": "UPDATE DBO.ORDER_TABLE SET STATUS = 'DONE' WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "test_g",
"BlockedClientApp": ".Net SqlClient Data Provider",
"BlockedSqlMd5": "7d944d41c2e6dabe7a888207c073288d",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:38",
"BlockedSqlTemplate": "UPDATE DBO.ORDER_TABLE SET STATUS = ? WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "read committed (2)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 537998933,
"BlockedWaitTimeMs": 7815,
"BlockedInputBuffer": "SELECT * FROM DBO.ORDER_TABLE WITH (UPDLOCK) WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "test_g",
"BlockedClientApp": "jdbc-mssql",
"BlockedSqlMd5": "6d93759d80eb316de6bd0954917fee13",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:43",
"BlockedSqlTemplate": "SELECT * FROM DBO.ORDER_TABLE WITH (UPDLOCK) WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "repeatable read (3)",
"RootCause": "C1_LONG_QUERY",
"Children": [
{
"BlockedHostName": "TEN-4DUQ5CVE6R",
"BlockedStatus": "suspended",
"BlockedTransactionId": 649799463,
"BlockedWaitTimeMs": 8084,
"BlockedInputBuffer": "SELECT * FROM DBO.ORDER_TABLE WITH (UPDLOCK) WHERE ID = 1",
"BlockedTranCount": 3,
"BlockedLoginName": "app_user",
"BlockedClientApp": "python-pymssql",
"BlockedSqlMd5": "6d93759d80eb316de6bd0954917fee13",
"BlockedLockMode": "X",
"BlockedLastTranStarted": "2026-10-21 19:20:30",
"BlockedSqlTemplate": "SELECT * FROM DBO.ORDER_TABLE WITH (UPDLOCK) WHERE ID = ?",
"ReportTime": "2026-10-21 21:05:33",
"BlockedWaitResource": "KEY: 14:1732724499 (70f59de93dea) ",
"BlockedIsolationLevel": "serializable (4)",
"RootCause": "C1_LONG_QUERY",
"BlockedSessionId": 6373,
"BlockedTransactionName": "user_transaction"
}
],
"BlockedSessionId": 54501,
"BlockedTransactionName": "SELECT"
}
],
"BlockedSessionId": 43103,
"BlockedTransactionName": "UPDATE"
}
],
"BlockedSessionId": 36729,
"BlockedTransactionName": "UPDATE"
}
],
"BlockedSessionId": 24711,
"BlockedTransactionName": "DELETE"
}
],
"BlockedSessionId": 16211,
"BlockedTransactionName": "DELETE"
}
],
"BlockedSessionId": 13767,
"BlockedTransactionName": "DELETE"
}
],
"BlockedSessionId": 31618,
"BlockedTransactionName": "SELECT"
}
],
"BlockedSessionId": 56501,
"BlockedTransactionName": "DELETE"
}
],
"RootCause": "C1_LONG_QUERY",
"BlockingInputBuffer": "EXEC DBO.SP_LONG_LOCK_HOLDER @hold_minutes = 30",
"BlockingHostName": "TEN-4DUQ5CVE6R",
"BlockingLoginName": "report_svc",
"ChainLength": 9
}
],
"RequestId": "a3228322-385e-4237-8101-08c74b0dfda2"
}
}
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签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AuditNotOpened | 实例审计未开启 |
| FailedOperation.PaasAuditNotOpened | paas 侧商业审计状态未开启 |
| FailedOperation.SegmentLoading | 数据加载中 |
| InternalError | 内部错误。 |
| InternalError.DbOperationFailed | 数据库操作失败 |
| InternalError.InternalError | InternalError.InternalError |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.HasDuplicatedTask | 该时间范围内的审计日志已下载 |