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

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": {
  5. "column_names": [
  6. "Query ID",
  7. "FE节点",
  8. "查询用户",
  9. "执行数据库",
  10. "Sql",
  11. "查询类型",
  12. "开始时间",
  13. "结束时间",
  14. "执行时长",
  15. "状态"
  16. ],
  17. "rows": [
  18. [
  19. ...
  20. ]
  21. ]
  22. },
  23. "count": 0
  24. }

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

Examples

  1. GET /rest/v2/manager/query/query_info
  2. {
  3. "msg": "success",
  4. "code": 0,
  5. "data": {
  6. "column_names": [
  7. "Query ID",
  8. "FE节点",
  9. "查询用户",
  10. "执行数据库",
  11. "Sql",
  12. "查询类型",
  13. "开始时间",
  14. "结束时间",
  15. "执行时长",
  16. "状态"
  17. ],
  18. "rows": [
  19. [
  20. "d7c93d9275334c35-9e6ac5f295a7134b",
  21. "127.0.0.1:8030",
  22. "root",
  23. "default_cluster:testdb",
  24. "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",
  25. "Query",
  26. "2021-07-29 16:59:12",
  27. "2021-07-29 16:59:12",
  28. "109ms",
  29. "EOF"
  30. ]
  31. ]
  32. },
  33. "count": 0
  34. }

通过 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

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": "fb1d9737de914af1-a498d5c5dec638d3",
  5. "count": 0
  6. }

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

  1. {
  2. "msg": "Bad Request",
  3. "code": 403,
  4. "data": "error messages",
  5. "count": 0
  6. }

获取指定查询的 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

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": {
  5. "sql": ""
  6. },
  7. "count": 0
  8. }
  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": {
  5. "profile": ""
  6. },
  7. "count": 0
  8. }

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

  1. {
  2. "msg": "Bad Request",
  3. "code": 403,
  4. "data": "error messages",
  5. "count": 0
  6. }

Examples

  1. 获取 sql:

    1. GET /rest/v2/manager/query/sql/d7c93d9275334c35-9e6ac5f295a7134b
    2. Response:
    3. {
    4. "msg": "success",
    5. "code": 0,
    6. "data": {
    7. "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"
    8. },
    9. "count": 0
    10. }

获取指定查询 fragment 和 instance 信息

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

Query Profile Action - 图1警告

自 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

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": [
  5. {
  6. "fragment_id": "",
  7. "time": "",
  8. "instance_id": {
  9. "": {
  10. "host": "",
  11. "active_time": ""
  12. }
  13. }
  14. }
  15. ],
  16. "count": 0
  17. }

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

  1. {
  2. "msg": "Bad Request",
  3. "code": 403,
  4. "data": "error messages",
  5. "count": 0
  6. }

Examples

  1. GET /rest/v2/manager/query/profile/fragments/d7c93d9275334c35-9e6ac5f295a7134b
  2. Response:
  3. {
  4. "msg": "success",
  5. "code": 0,
  6. "data": [
  7. {
  8. "fragment_id": "0",
  9. "time": "36.169ms",
  10. "instance_id": {
  11. "d7c93d9275334c35-9e6ac5f295a7134e": {
  12. "host": "172.19.0.4:9060",
  13. "active_time": "36.169ms"
  14. }
  15. }
  16. },
  17. {
  18. "fragment_id": "1",
  19. "time": "20.710ms",
  20. "instance_id": {
  21. "d7c93d9275334c35-9e6ac5f295a7134c": {
  22. "host": "172.19.0.5:9060",
  23. "active_time": "20.710ms"
  24. }
  25. }
  26. },
  27. {
  28. "fragment_id": "2",
  29. "time": "7.83ms",
  30. "instance_id": {
  31. "d7c93d9275334c35-9e6ac5f295a7134d": {
  32. "host": "172.19.0.6:9060",
  33. "active_time": "7.83ms"
  34. },
  35. "d7c93d9275334c35-9e6ac5f295a7134f": {
  36. "host": "172.19.0.7:9060",
  37. "active_time": "10.873ms"
  38. }
  39. }
  40. }
  41. ],
  42. "count": 0
  43. }

获取指定 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_idinstance_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

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": {
  5. "graph":""
  6. },
  7. "count": 0
  8. }

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

  1. {
  2. "msg": "Bad Request",
  3. "code": 403,
  4. "data": "error messages",
  5. "count": 0
  6. }

正在执行的 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

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

取消 query

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

Description

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

Path parameters

  • {query_id}

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

Query parameters

Response

  1. {
  2. "msg": "success",
  3. "code": 0,
  4. "data": null,
  5. "count": 0
  6. }