全部产品
Search

搜索本产品

    云数据库 OceanBase：DescribeSQLTuningAdvices - 查询 SQL 的优化建议

    文档中心

    云数据库 OceanBase：DescribeSQLTuningAdvices - 查询 SQL 的优化建议

    更新时间：Oct 23, 2024

    查询 SQL 的优化建议包括两种：索引创建的建议、执行计划绑定的建议。

    调试

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

    授权信息

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

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

    请求参数

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

    集群 id

    		obsdf43****
    TenantIdstring是

    租户 ID

    		tsdc2s2****
    DbNamestring是

    数据库名称

    		testdb
    SqlIdstring是

    SqlId

    		123456
    StartTimestring是

    开始时间

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

    结束时间

    		2023-04-12T05:38:38Z
    AcceptLanguagestring否

    支持的语言。取值：

    • 中文：zh-CN
    • 英文：en-US
    		zh-CN

    返回参数

    名称类型描述示例值
    object

    请求的返回结果

    RequestIdstring

    请求 ID

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Dataarray<object>

    SQL 执行计划信息列表。

    Dataobject

    SQL 执行计划信息。

    Typestring

    优化类型

    		PLAN_BINDING/INDEX_CREATION
    ColumnNamesstring

    索引列顺序

    		c1;c2;c3
    LocalityTypestring

    索引类型

    		Local/Global
    Columnsarray<object>

    索引列列表

    Columnsobject

    索引列信息

    ColumnNamestring

    列名

    		xxxx
    Ndvfloat

    NDV

    		100
    MinValuestring

    最小值

    		1
    MaxValuestring

    最大值

    		100
    DbNamestring

    数据库名称

    		test_db
    Tablestring

    表名

    		test_table
    Planobject

    执行计划

    Executionslong

    期间的总执行次数。

    		2062
    AvgCpuTimefloat

    期间内的平均 CPU 时间（毫秒）。

    		100.36
    PlanHashstring

    SQL 执行计划在诊断系统内部的标识。

    		-86290582****886880
    TimeoutPercentagefloat

    超时百分比。

    		0
    AvgConcurrencyWaitTimefloat

    期间内的平均 Concurrency 事件等待时间（毫秒）。

    		0
    FirstLoadTimeUslong

    首次加载时间。

    		1672367130576163
    AvgDiskWritesfloat

    期间内的平均物理写入次数。

    		0
    AvgUserIoWaitTimefloat

    期间内的平均 UserIo 事件等待时间（毫秒）。

    		0
    PlanSizelong

    计划大小。

    		49216
    ServerSnstring

    节点 ID。

    		i-bp1*****sw64dhb*****
    OutlineDatastring

    SQL 执行计划的 outline_data 字段。

    		xxxxx
    PlanTypestring

    Plan 类型：LOCAL、REMOTE、DIST。

    		LOCAL
    ObDbIdlong

    数据库 ID。

    		1108307720799259
    HitPercentagefloat

    命中率。

    		66.8
    AvgBufferGetsfloat

    计划在期间内的平均缓存读次数。

    		0
    ExecPsfloat

    期间的平均每秒执行次数。

    		1.45
    DelayedLargeQueryPercentagefloat

    长时间执行查询的延迟百分比。

    		0
    TableScanboolean

    是否全表扫描。

    		false
    LargeQueryPercentagefloat

    长时间执行查询的完成百分比。

    		0
    SchemaVersionlong

    Schema 版本。

    		1672367130529680
    PlanIdlong

    计划 ID。

    		818
    FirstLoadTimestring

    首次加载时间。

    		2022-12-30T02:25:30.576Z
    AvgRowProcessedfloat

    期间内的平均行处理等待时间（毫秒）。

    		1
    MergedVersionlong

    合并版本。

    		3
    HitDiagnosisboolean

    是否命中诊断。

    		false
    Uidstring

    Plan 的唯一标识。

    		AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj
    AvgApplicationWaitTimefloat

    期间内的平均 Application 事件等待时间（毫秒）。

    		0
    CollectTimeUslong

    收集时间。

    		1672358400000000
    AvgElapsedTimefloat

    期间内的平均间隔等待时间（毫秒）。

    		713.62
    ObServerIdlong

    server ID。

    		1
    OutlineIdlong

    Outline ID。

    		1
    AvgDiskReadsfloat

    期间内的平均物理读次数。

    		0

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": [
    {
      "Type": "PLAN_BINDING/INDEX_CREATION",
      "ColumnNames": "c1;c2;c3",
      "LocalityType": "Local/Global",
      "Columns": [
        {
          "ColumnName": "xxxx",
          "Ndv": 100,
          "MinValue": "1",
          "MaxValue": "100"
        }
      ],
      "DbName": "test_db",
      "Table": "test_table",
      "Plan": {
        "Executions": 2062,
        "AvgCpuTime": 100.36,
        "PlanHash": "-86290582****886880",
        "TimeoutPercentage": 0,
        "AvgConcurrencyWaitTime": 0,
        "FirstLoadTimeUs": 1672367130576163,
        "AvgDiskWrites": 0,
        "AvgUserIoWaitTime": 0,
        "PlanSize": 49216,
        "ServerSn": "i-bp1*****sw64dhb*****",
        "OutlineData": "xxxxx",
        "PlanType": "LOCAL",
        "ObDbId": 1108307720799259,
        "HitPercentage": 66.8,
        "AvgBufferGets": 0,
        "ExecPs": 1.45,
        "DelayedLargeQueryPercentage": 0,
        "TableScan": false,
        "LargeQueryPercentage": 0,
        "SchemaVersion": 1672367130529680,
        "PlanId": 818,
        "FirstLoadTime": "2022-12-30T02:25:30.576Z",
        "AvgRowProcessed": 1,
        "MergedVersion": 3,
        "HitDiagnosis": false,
        "Uid": "AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj",
        "AvgApplicationWaitTime": 0,
        "CollectTimeUs": 1672358400000000,
        "AvgElapsedTime": 713.62,
        "ObServerId": 1,
        "OutlineId": 1,
        "AvgDiskReads": 0
      }
    }
  ]
}

    错误码

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