查询慢 SQL 执行明细的采样数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
oceanbase:DescribeSQLSamples |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
否 |
OceanBase 集群 ID。 |
ob317v4uif**** |
| TenantId |
string |
否 |
租户 ID。 |
t4louaeei**** |
| StartTime |
string |
是 |
查看慢 SQL 执行的起始时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。 |
2023-04-12T04:38:38Z |
| EndTime |
string |
是 |
查看慢 SQL 执行的结束时间。 该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。 |
2023-04-12T05:38:38Z |
| DbName |
string |
是 |
数据库名称。 |
test_db |
| SqlId |
string |
是 |
SQL ID。 |
8D6E84****0B8FB1823D199E2CA1**** |
| ReturnSqlText |
boolean |
否 |
是否返回 SQL 文本。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
请求的返回参数。 |
||
| RequestId |
string |
请求 ID。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Data |
array<object> |
慢 SQL 执行明细的采样信息列表。 |
|
|
object |
慢 SQL 执行明细的采样信息。 |
||
| RequestId |
integer |
请求 ID。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| TraceId |
string |
跟踪 ID。 |
YB42C****-0005E303D1****-0-0 |
| RequestTime |
string |
SQL 的请求时间。 |
2023-04-12T04:46:38Z |
| Server |
string |
SQL 执行所在的 Server。 |
i-bp1db1****8uemejio |
| ClientIp |
string |
客户端 IP。 |
i-bp1db****38uemejio |
| ClientPort |
integer |
客户端端口。 |
4**** |
| DbName |
string |
数据库名称。 |
test_db |
| UserName |
string |
用户名。 |
test_user |
| SqlType |
string |
SQL 类型。 |
select |
| PlanId |
integer |
执行计划 ID。 |
590**** |
| AffectedRows |
integer |
期间内平均更新行数。 |
10000.0 |
| ReturnRows |
integer |
期间内平均返回行数。 |
0.0 |
| PartitionCount |
integer |
期间内平均访问分区数。 |
1.0 |
| RetCode |
integer |
结果码。 |
0 |
| WaitEvent |
string |
期间内的最长等待事件。 |
none |
| WaitTime |
number |
等待时间（毫秒）。 |
0.0 |
| WaitCount |
integer |
等待次数。 |
0.0 |
| RpcCount |
integer |
发送 RPC 次数。 |
8.0 |
| PlanType |
string |
计划类型。 |
LOCAL |
| Inner |
boolean |
是否内部 SQL。 |
false |
| ExecutorRpc |
boolean |
是否发起 RPC。 |
0.0 |
| HitPlan |
boolean |
是否命中执行计划。 |
true |
| ElapsedTime |
number |
响应时间（毫秒）。 |
2182.66 |
| CpuTime |
number |
CPU 时间（毫秒）。 |
3377.57 |
| NetTime |
number |
网络传输时间（毫秒）。 |
0.0 |
| NetWaitTime |
number |
网络入队时间（毫秒）。 |
0.0 |
| QueueTime |
number |
排队时间（毫秒）。 |
0.02 |
| DecodeTime |
number |
语法解析时间（毫秒）。 |
0.0 |
| GetPlanTime |
number |
计划生成时间（毫秒）。 |
0.19 |
| ExecuteTime |
number |
计划执行时间（毫秒）。 |
8262.01 |
| ApplicationWaitTime |
number |
Application 事件等待时间（毫秒）。 |
0.0 |
| ConcurrencyWaitTime |
number |
Concurrency 事件等待时间（毫秒）。 |
0.0 |
| UserIoWaitTime |
number |
UserIO 事件等待时间（毫秒）。 |
0.0 |
| ScheduleTime |
number |
Schedule 事件等待时间（毫秒）。 |
0.0 |
| RowCacheHit |
number |
RowCache 命中次数。 |
498.0 |
| BloomFilterCacheHit |
number |
BloomFilterCache 命中次数。 |
0.0 |
| BlockCacheHit |
number |
BlockCache 命中次数。 |
99279.0 |
| BlockIndexCacheHit |
number |
BlockIndexCache 命中次数 磁盘读次数。 |
142514.0 |
| DiskReads |
number |
磁盘读次数。 |
96972.0 |
| RetryCount |
integer |
重试次数。 |
0 |
| TableScan |
boolean |
是否全表扫描。 |
false |
| ConsistencyLevel |
string |
一致性级别。 |
3 |
| MemstoreReadRows |
integer |
Memstore 读行数。 |
0 |
| ExpectedWorkerCount |
integer |
并行度。 |
0 |
| UsedWorkerCount |
integer |
SQL 实际执行线程数。 |
0 |
| SsstoreReadRows |
integer |
Ssstore 读行数。 |
986190 |
| ObServerId |
integer |
server ID。 |
2 |
| ObUserId |
integer |
用户 ID。 |
100010 |
| ObDbId |
integer |
数据库 ID。 |
11006111****4828 |
| Statement |
string |
参数化 SQL 文本。 |
select a from b |
| TransHash |
string |
transaction hash。 |
1219****927****73791 |
| FullSqlText |
string |
完整的 SQL 文本。 说明
此参数暂时不可用。 |
select * from test where c1 > 1 and c2 > 3; |
| SqlText |
string |
SQL 语句。 |
select ** from t |
| ParamsValue |
string |
SQL 参数值。 |
1**** |
| SqlId |
string |
||
| SqlTextShort |
string |
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": [
{
"RequestId": 0,
"TraceId": "YB42C****-0005E303D1****-0-0",
"RequestTime": "2023-04-12T04:46:38Z",
"Server": "i-bp1db1****8uemejio",
"ClientIp": "i-bp1db****38uemejio",
"ClientPort": 0,
"DbName": "test_db",
"UserName": "test_user",
"SqlType": "select",
"PlanId": 0,
"AffectedRows": 10000,
"ReturnRows": 0,
"PartitionCount": 1,
"RetCode": 0,
"WaitEvent": "none",
"WaitTime": 0,
"WaitCount": 0,
"RpcCount": 8,
"PlanType": "LOCAL",
"Inner": false,
"ExecutorRpc": true,
"HitPlan": true,
"ElapsedTime": 2182.66,
"CpuTime": 3377.57,
"NetTime": 0,
"NetWaitTime": 0,
"QueueTime": 0.02,
"DecodeTime": 0,
"GetPlanTime": 0.19,
"ExecuteTime": 8262.01,
"ApplicationWaitTime": 0,
"ConcurrencyWaitTime": 0,
"UserIoWaitTime": 0,
"ScheduleTime": 0,
"RowCacheHit": 498,
"BloomFilterCacheHit": 0,
"BlockCacheHit": 99279,
"BlockIndexCacheHit": 142514,
"DiskReads": 96972,
"RetryCount": 0,
"TableScan": false,
"ConsistencyLevel": "3",
"MemstoreReadRows": 0,
"ExpectedWorkerCount": 0,
"UsedWorkerCount": 0,
"SsstoreReadRows": 986190,
"ObServerId": 2,
"ObUserId": 100010,
"ObDbId": 0,
"Statement": "select a from b",
"TransHash": "1219****927****73791",
"FullSqlText": "select * from test where c1 > 1 and c2 > 3;",
"SqlText": "select ** from t",
"ParamsValue": "1****",
"SqlId": "",
"SqlTextShort": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。