查询GeminiDB Cassandra数据库慢日志 - QueryingSlowQueryLogsofaGeminiDBCassandraInstance

功能介绍

查询GeminiDB Cassandra数据库慢日志信息，支持日志关键字搜索。

接口约束

不支持使用 &&、||、AND、OR、NOT、*、？、:、>、<、=、>=、<=这些关键字来搜索日志。
查询到的慢日志数据在入参start_time和end_time的时间段内。
当次查询的日志起始行号line_num须从上一次查询的日志返回信息中获取，第一次查询可不传。
每页查询最大限制100条，慢日志最多保存30天。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listSlowLog
List
instance *
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
nosql:instance:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbfornosql:instance:listSlowLog	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:list	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。获取方法请参见获取项目ID。
instance_id	是	String	实例ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。

表3 请求Body参数
参数	是否必选	参数类型	描述
start_time	是	String	开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。注：开始时间不得早于当前时间30天。
end_time	是	String	结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。注：结束时间不能晚于当前时间。
limit	是	Integer	表示每次查询的日志条数，最大限制100条。
line_num	否	String	日志单行序列号，第一次查询时不需要此参数，下一次查询时需要使用，可从上一次查询的返回信息中获取。说明：当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。
operate_type	否	String	语句类型，取空值，表示查询所有语句类型。取值：select
node_id	否	String	节点ID，取空值，表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。
keywords	否	Array of strings	根据多个关键字搜索日志全文，表示同时匹配所有关键字。最多支持10个关键字。每个关键字最大长度不超过512个字符。
keyspace_keywords	否	Array of strings	根据多个键空间关键字模糊搜索日志，表示匹配至少一个关键字。只支持关键字前缀模糊搜索，最多支持10个关键字。每个关键字最大长度不超过48个字符。
table_keywords	否	Array of strings	根据多个数据库表名关键字模糊搜索日志，表示匹配至少一个关键字。只支持关键字前缀模糊搜索，最多支持10个关键字。每个关键字最大长度不超过48个字符。
max_cost_time	否	Integer	支持根据最大执行时间范围查找日志。单位：ms。
min_cost_time	否	Integer	支持根据最小执行时间范围查找日志。单位：ms。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
slow_logs	Array of objects	慢日志具体信息。详情请参考表5。

表5 CassandraSlowLogDetail
参数	参数类型	描述
node_name	String	节点名称。
node_id	String	节点ID。
whole_message	String	执行语句。
operate_type	String	语句类型。取值为select。
cost_time	Integer	执行时间。单位：ms
keyspace	String	数据库键空间。
table	String	数据库表名。
log_time	String	日志产生时间，UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
line_num	String	日志单行序列号。

请求示例

POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/cassandra/instances/853f97101a9a4f618202f281cda82e92in06/slow-logs 
 
{ 
  "start_time" : "2023-01-06T10:41:14+0800", 
  "end_time" : "2023-01-10T10:41:14+0800", 
  "limit" : 100, 
  "line_num" : "1595659490239433658", 
  "operate_type" : "select", 
  "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", 
  "keywords" : [ "log", "test" ], 
  "keyspace_keywords" : [ "system", "system_auth" ], 
  "table_keywords" : [ "test" ], 
  "max_cost_time" : 100, 
  "min_cost_time" : 50 
}

响应示例

状态码： 200

Success

{ 
  "slow_logs" : [ { 
    "node_name" : "test_priam_node_1", 
    "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", 
    "keyspace" : "system", 
    "table" : "test", 
    "whole_message" : "GqKc6_S", 
    "operate_type" : "select", 
    "cost_time" : 60, 
    "log_time" : "2023-01-09T05:42:32.000+0000", 
    "line_num" : "1595659490239433659" 
  } ] 
}