更新时间:2024-09-11 GMT+08:00

查询慢日志

功能介绍

获取慢日志信息。

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse/slow-logs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

instance_id

String

ClickHouse实例ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

node_id

String

实例节点ID。

start_time

String

开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

end_time

String

开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

limit

Integer

查询记录数。

line_num

String

日志单行序列号,第一次查询时不需要此参数,后续分页查询时需要使用,可从上次查询的返回信息中获取。

operate_type

String

慢日志操作类型。

database

String

数据库名。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

slow_log_list

Array of slow_log_list objects

慢日志列表。

表5 slow_log_list

参数

参数类型

描述

node_id

String

ClickHouse实例节点ID。

time

String

数据库语句执行时间。

lock_time

String

数据库语句等待锁时间。

rows_sent

Integer

数据库语句执行结果行数。

rows_examined

Integer

数据库语句扫描行数。

database

String

所属数据库名。

users

String

执行语句账号。

query_sample

String

数据库执行语句。

type

String

数据库语句类型。

client_ip

String

IP地址。

start_time

String

数据库语句发生时间。

line_num

String

日志单行序列号,第一次查询时不需要此参数,后续分页查询时需要使用,可从上次查询的返回信息中获取。

count

String

慢日志数量。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

获取内核慢日志信息。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/clickhouse/slow-logs

{
  "node_id" : "aeb9e81135b34197bab8636fc8a1c569no16",
  "start_time" : "2023-12-12T00:14:27+0100",
  "end_time" : "2023-12-12T02:14:27+0100",
  "limit" : "10",
  "line_num" : "1669344916000",
  "operate_type" : "All",
  "database" : "DBS_NODE"
}

响应示例

状态码: 200

Success.

{
  "slow_log_list" : [ {
    "node_id" : "941d21130b3c4899ad1a752a0945befdno07",
    "time" : "0.000143s",
    "rows_sent" : "10",
    "rows_examined" : "50",
    "database" : "user_center",
    "users" : "admin",
    "query_sample" : "sleep (N);",
    "type" : "1700755200000",
    "client_ip" : "10.1.1.60",
    "start_time" : "2023-08-28T08:22:13.591394+08:00",
    "line_num" : "1669344916000"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码