全部产品
Search

搜索本产品

    云数据库 OceanBase：DescribeSQLSamples - 查询慢 SQL 执行明细的采样数据

    文档中心

    云数据库 OceanBase：DescribeSQLSamples - 查询慢 SQL 执行明细的采样数据

    更新时间：Nov 22, 2024

    查询慢 SQL 执行明细的采样数据。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    oceanbase:DescribeSQLSamplesget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring否

    OceanBase 集群 ID。

    		ob317v4uif****
    TenantIdstring否

    租户 ID。

    		t4louaeei****
    StartTimestring是

    查看慢 SQL 执行的起始时间。

    该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。

    		2023-04-12T04:38:38Z
    EndTimestring是

    查看慢 SQL 执行的结束时间。

    该时间只支持 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。

    		2023-04-12T05:38:38Z
    DbNamestring是

    数据库名称。

    		test_db
    SqlIdstring是

    SQL ID。

    		8D6E84****0B8FB1823D199E2CA1****
    ReturnSqlTextboolean否

    是否返回 SQL 文本。

    		true

    返回参数

    名称类型描述示例值
    object

    请求的返回参数。

    RequestIdstring

    请求 ID。

    		EE205C00-30E4-****-****-87E3A8A2AA0C
    Dataarray<object>

    慢 SQL 执行明细的采样信息列表。

    Dataobject

    慢 SQL 执行明细的采样信息。

    RequestIdstring

    请求 ID。

    		EE205C00-30E4-****-****-87E3A8A2AA0C
    TraceIdstring

    跟踪 ID。

    		YB42C****-0005E303D1****-0-0
    RequestTimestring

    SQL 的请求时间。

    		2023-04-12T04:46:38Z
    Serverstring

    SQL 执行所在的 Server。

    		i-bp1db1****8uemejio
    ClientIpstring

    客户端 IP。

    		i-bp1db****38uemejio
    ClientPortstring

    客户端端口。

    		4****
    DbNamestring

    数据库名称。

    		test_db
    UserNamestring

    用户名。

    		test_user
    SqlTypestring

    SQL 类型。

    		select
    PlanIddouble

    执行计划 ID。

    		590****
    AffectedRowsdouble

    期间内平均更新行数。

    		10000.0
    ReturnRowsdouble

    期间内平均返回行数。

    		0.0
    PartitionCountdouble

    期间内平均访问分区数。

    		1.0
    RetCodedouble

    结果码。

    		0
    WaitEventstring

    期间内的最长等待事件。

    		none
    WaitTimedouble

    等待时间（毫秒）。

    		0.0
    WaitCountdouble

    等待次数。

    		0.0
    RpcCountdouble

    发送 RPC 次数。

    		8.0
    PlanTypestring

    计划类型。

    		LOCAL
    Innerboolean

    是否内部 SQL。

    		false
    ExecutorRpcboolean

    是否发起 RPC。

    		0.0
    HitPlanboolean

    是否命中执行计划。

    		true
    ElapsedTimedouble

    响应时间（毫秒）。

    		2182.66
    CpuTimedouble

    CPU 时间（毫秒）。

    		3377.57
    NetTimedouble

    网络传输时间（毫秒）。

    		0.0
    NetWaitTimedouble

    网络入队时间（毫秒）。

    		0.0
    QueueTimedouble

    排队时间（毫秒）。

    		0.02
    DecodeTimedouble

    语法解析时间（毫秒）。

    		0.0
    GetPlanTimedouble

    计划生成时间（毫秒）。

    		0.19
    ExecuteTimedouble

    计划执行时间（毫秒）。

    		8262.01
    ApplicationWaitTimedouble

    Application 事件等待时间（毫秒）。

    		0.0
    ConcurrencyWaitTimedouble

    Concurrency 事件等待时间（毫秒）。

    		0.0
    UserIoWaitTimedouble

    UserIO 事件等待时间（毫秒）。

    		0.0
    ScheduleTimedouble

    Schedule 事件等待时间（毫秒）。

    		0.0
    RowCacheHitdouble

    RowCache 命中次数。

    		498.0
    BloomFilterCacheHitdouble

    BloomFilterCache 命中次数。

    		0.0
    BlockCacheHitdouble

    BlockCache 命中次数。

    		99279.0
    BlockIndexCacheHitdouble

    BlockIndexCache 命中次数 磁盘读次数。

    		142514.0
    DiskReadsdouble

    磁盘读次数。

    		96972.0
    RetryCountdouble

    重试次数。

    		0
    TableScanboolean

    是否全表扫描。

    		false
    ConsistencyLevelstring

    一致性级别。

    		3
    MemstoreReadRowsdouble

    Memstore 读行数。

    		0
    ExpectedWorkerCountdouble

    并行度。

    		0
    UsedWorkerCountdouble

    SQL 实际执行线程数。

    		0
    SsstoreReadRowsdouble

    Ssstore 读行数。

    		986190
    ObServerIddouble

    server ID。

    		2
    ObUserIddouble

    用户 ID。

    		100010
    ObDbIddouble

    数据库 ID。

    		11006111****4828
    Statementstring

    参数化 SQL 文本。

    		select a from b
    TransHashstring

    transaction hash。

    		1219****927****73791
    FullSqlTextstring

    完整的 SQL 文本。

    说明 此参数暂时不可用。
    		select * from test where c1 > 1 and c2 > 3;
    SqlTextstring

    SQL 语句。

    		select ** from t
    ParamsValuestring

    SQL 参数值。

    		1****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
      "TraceId": "YB42C****-0005E303D1****-0-0",
      "RequestTime": "2023-04-12T04:46:38Z",
      "Server": "i-bp1db1****8uemejio",
      "ClientIp": "i-bp1db****38uemejio",
      "ClientPort": "4****",
      "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****"
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-08-15OpenAPI 返回结构发生变更查看变更详情
    2024-04-15OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-12-11OpenAPI 返回结构发生变更查看变更详情
    2023-10-30OpenAPI 返回结构发生变更查看变更详情