跳到主要内容
跳到主要内容

Query Profile Action

Request​

GET /rest/v2/manager/query/query_info

GET /rest/v2/manager/query/trace/{trace_id}

GET /rest/v2/manager/query/sql/{query_id}

GET /rest/v2/manager/query/profile/text/{query_id}

GET /rest/v2/manager/query/profile/graph/{query_id}

GET /rest/v2/manager/query/profile/json/{query_id}

GET /rest/v2/manager/query/profile/fragments/{query_id}

GET /rest/v2/manager/query/current_queries

GET /rest/v2/manager/query/kill/{query_id}

获取查询信息​

GET /rest/v2/manager/query/query_info

Description​

可获取集群所有 fe 节点 select 查询信息。

Query parameters​

  • query_id

    可选，指定返回查询的 queryID，默认返回所有查询的信息。

  • search

    可选，指定返回包含字符串的查询信息，目前仅进行字符串匹配。

  • is_all_node

    可选，若为 true 则返回所有 fe 节点的查询信息，若为 false 则返回当前 fe 节点的查询信息。默认为 true。

Response​

{
    "msg": "success",
    "code": 0,
    "data": {
        "column_names": [
            "Query ID",
            "FE节点",
            "查询用户",
            "执行数据库",
            "Sql",
            "查询类型",
            "开始时间",
            "结束时间",
            "执行时长",
            "状态"
        ],
        "rows": [
            [
                ...
            ]
        ]
    },
    "count": 0
}

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。

Examples​

GET /rest/v2/manager/query/query_info

{
    "msg": "success",
    "code": 0,
    "data": {
        "column_names": [
            "Query ID",
            "FE节点",
            "查询用户",
            "执行数据库",
            "Sql",
            "查询类型",
            "开始时间",
            "结束时间",
            "执行时长",
            "状态"
        ],
        "rows": [
            [
                "d7c93d9275334c35-9e6ac5f295a7134b",
                "127.0.0.1:8030",
                "root",
                "default_cluster:testdb",
                "select c.id, c.name, p.age, p.phone, c.date, c.cost from cost c join people p on c.id = p.id where p.age > 20 order by c.id",
                "Query",
                "2021-07-29 16:59:12",
                "2021-07-29 16:59:12",
                "109ms",
                "EOF"
            ]
        ]
    },
    "count": 0
}

通过 Trace Id 获取 Query Id​

GET /rest/v2/manager/query/trace_id/{trace_id}

Description​

通过 Trace Id 获取 Query Id.

在执行一个 Query 前，先设置一个唯一的 trace id:

set session_context="trace_id:your_trace_id";

在同一个 Session 链接内执行 Query 后，可以通过 trace id 获取 query id。

Path parameters​

  • {trace_id}

    用户设置的 trace id.

Query parameters​

Response​

{
    "msg": "success", 
    "code": 0, 
    "data": "fb1d9737de914af1-a498d5c5dec638d3", 
    "count": 0
}

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。若指定 trace id 不存在或无权限，则返回 Bad Request：

{
    "msg": "Bad Request", 
    "code": 403, 
    "data": "error messages",
    "count": 0
}

获取指定查询的 sql 和文本 profile​

GET /rest/v2/manager/query/sql/{query_id}

GET /rest/v2/manager/query/profile/text/{query_id}

Description​

用于获取指定 Query ID 的 SQL 和 profile 文本。

Path parameters​

  • query_id

    query id.

Query parameters​

  • is_all_node

    可选，若为 true 则在所有 FE 节点中查询指定 query id 的信息，若为 false 则在当前连接的 FE 节点中查询指定 query id 的信息。默认为 true。

Response​

{
    "msg": "success",
    "code": 0,
    "data": {
        "sql": ""
    },
    "count": 0
}
{
    "msg": "success",
    "code": 0,
    "data": {
        "profile": ""
    },
    "count": 0
}

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。若指定 query id 不存在或无权限，则返回 Bad Request：

{
    "msg": "Bad Request", 
    "code": 403, 
    "data": "error messages",
    "count": 0
}

Examples​

  1. 获取 sql：

    GET /rest/v2/manager/query/sql/d7c93d9275334c35-9e6ac5f295a7134b

    Response:
    {
        "msg": "success",
        "code": 0,
        "data": {
            "sql": "select c.id, c.name, p.age, p.phone, c.date, c.cost from cost c join people p on c.id   = p.id where p.age > 20 order by c.id"
        },
        "count": 0
    }

获取指定查询 fragment 和 instance 信息​

GET /rest/v2/manager/query/profile/fragments/{query_id}

警告

自 2.1.1 起，此接口被弃用。你仍然可以从 http://<fe_ip>:<fe_http_port>/QueryProfile 上下载 profile 文件。

Description​

用于获取指定 query id 的 fragment 名称，instance id、主机 IP 及端口和执行时长。

Path parameters​

  • query_id

    query id.

Query parameters​

  • is_all_node

    可选，若为 true 则在所有 fe 节点中查询指定 query id 的信息，若为 false 则在当前连接的 fe 节点中查询指定 query id 的信息。默认为 true。

Response​

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "fragment_id": "",
            "time": "",
            "instance_id": {
                "": {
                  "host": "",
                  "active_time": ""
                }
            }
        }
    ],
    "count": 0
}

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。若指定 query id 不存在或无权限，则返回 Bad Request：

{
    "msg": "Bad Request", 
    "code": 403, 
    "data": "error messages",
    "count": 0
}

Examples​

GET /rest/v2/manager/query/profile/fragments/d7c93d9275334c35-9e6ac5f295a7134b

Response:
{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "fragment_id": "0",
            "time": "36.169ms",
            "instance_id": {
                "d7c93d9275334c35-9e6ac5f295a7134e": {
                    "host": "172.19.0.4:9060",
                    "active_time": "36.169ms"
                }
            }
        },
        {
            "fragment_id": "1",
            "time": "20.710ms",
            "instance_id": {
                "d7c93d9275334c35-9e6ac5f295a7134c": {
                    "host": "172.19.0.5:9060",
                    "active_time": "20.710ms"
                }
            }
        },
        {
            "fragment_id": "2",
            "time": "7.83ms",
            "instance_id": {
                "d7c93d9275334c35-9e6ac5f295a7134d": {
                    "host": "172.19.0.6:9060",
                    "active_time": "7.83ms"
                },
                "d7c93d9275334c35-9e6ac5f295a7134f": {
                    "host": "172.19.0.7:9060",
                    "active_time": "10.873ms"
                }
            }
        }
    ],
    "count": 0
}

获取指定 query id 树状 profile 信息​

GET /rest/v2/manager/query/profile/graph/{query_id}

Description​

获取指定 query id 树状 profile 信息，同 show query profile 指令。

Path parameters​

  • query_id

    query id.

Query parameters​

  • fragment_id 和 instance_id

    可选，这两个参数需同时指定或同时不指定。
    同时不指定则返回 profile 简易树形图，相当于show query profile '/query_id';
    同时指定则返回指定 instance 详细 profile 树形图，相当于show query profile '/query_id/fragment_id/instance_id'.

  • is_all_node

    可选，若为 true 则在所有 fe 节点中查询指定 query id 的信息，若为 false 则在当前连接的 fe 节点中查询指定 query id 的信息。默认为 true。

Response​

{
    "msg": "success",
    "code": 0,
    "data": {
        "graph":""
    },
    "count": 0
}

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。若指定 query id 不存在或无权限，则返回 Bad Request：

{
    "msg": "Bad Request", 
    "code": 403, 
    "data": "error messages",
    "count": 0
}

正在执行的 query​

GET /rest/v2/manager/query/current_queries

Description​

同 show proc "/current_query_stmts"，返回当前正在执行的 query

Path parameters​

Query parameters​

  • is_all_node

    可选，若为 true 则返回所有 FE 节点当前正在执行的 query 信息。默认为 true。

Response​

{
    "msg": "success",
    "code": 0,
    "data": {
        "columnNames": ["Frontend", "QueryId", "ConnectionId", "Database", "User", "ExecTime", "SqlHash", "Statement"],
        "rows": [
            ["172.19.0.3", "108e47ab438a4560-ab1651d16c036491", "2", "", "root", "6074", "1a35f62f4b14b9d7961b057b77c3102f", "select sleep(60)"],
            ["172.19.0.11", "3606cad4e34b49c6-867bf6862cacc645", "3", "", "root", "9306", "1a35f62f4b14b9d7961b057b77c3102f", "select sleep(60)"]
        ]
    },
    "count": 0
}

取消 query​

POST /rest/v2/manager/query/kill/{query_id}

Description​

取消执行连接中正在执行的 query

Path parameters​

  • {query_id}

    query id. 你可以通过 trace_id 接口，获取 query id。

Query parameters​

Response​

{
    "msg": "success",
    "code": 0,
    "data": null,
    "count": 0
}
Report issue
本页导航
ASF
Resources
Community
Join the community
Copyright © 2024 The Apache Software Foundation,Licensed under the Apache License, Version 2.0. Apache, Doris, Apache Doris, the Apache feather logo and the Apache Doris logo are trademarks of The Apache Software Foundation.