Querying Slow Query Logs of a GeminiDB Redis Instance

Function

This API is used to query slow query logs of GeminiDB Redis instances. Searching for slow query logs by keyword is supported.

Constraints

Operators &&, ||, AND, OR, NOT, *, ?, :, >, <, =, >=, and <= cannot be used to search for logs.
The query must be within the period specified by start_time and end_time.
The value of line_num must be obtained from the log information returned for the last query. This parameter is optional for the first query.
A maximum of 100 records can be queried on each page, and slow query logs can be stored for a maximum of 30 days.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:listSlowLog	List	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:list	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
start_time	Yes	String	Definition Start time Constraints The start time cannot be 30 days earlier than the current time and cannot be the same as the end time. The value of end_time must be later than that of start_time. The value is in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A Default Value N/A
end_time	Yes	String	Definition End time Constraints The end time cannot be later than the current time and cannot be the same as the start time. The value of end_time must be later than that of start_time. The value is in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A Default Value N/A
limit	Yes	Integer	Definition Number of logs queried each time Constraints N/A Range 1 to 100 Default Value N/A
line_num	No	String	Definition Sequence number of a single log line. The current query starts from the next log of line_num, excluding the log of line_num. Constraints This parameter is not required for the first query. The value can be obtained from the response of the last query. Range N/A Default Value N/A
operate_type	No	String	Definition Statement type Constraints N/A Range If this parameter is left blank, all statement types are queried. The following statement types can be queried: SET, GET, DEL, INCR, INCRBY, INCRBYFLOAT, DECR, DECRBY, GETSET, APPEND, MGET, KEYS, SETNX, SETEX, PSETEX, DELVX, MSET, MSETNX, GETRANGE, SUBSTR, SETRANGE, STRLEN, EXISTS, EXPIRE, PEXPIRE, EXPIREAT, PEXPIREAT, TTL, PTTL, PERSIST, TYPE, SCANX, PKSETEXAT, SORT, HDEL, HSET, HGET, HGETALL, HEXISTS, HINCRBY, HINCRBYFLOAT, HKEYS, HLEN, HMGET, HMSET, HSETNX, HSTRLEN, HVALS, HSCAN, HSCANX, PKHSCANRANGE, PKHRSCANRANGE, LINDEX, LINSERT, LLEN, LPOP, LPUSH, LPUSHX, LRANGE, LREM, LSET, LTRIM, RPOP, RPOPLPUSH, RPUSH, RPUSHX, ZADD, ZCARD, ZSCAN, ZINCRBY, ZRANGE, ZREVRANGE, ZRANGEBYSCORE, ZREVRANGEBYSCORE, ZCOUNT, ZREM, ZUNIONSTORE, ZINTERSTORE, ZRANK, ZREVRANK, ZSCORE, ZRANGEBYLEX, ZREVRANGEBYLEX, ZLEXCOUNT, ZREMRANGEBYRANK, ZREMRANGEBYSCORE, ZREMRANGEBYLEX, ZPOPMAX, ZPOPMIN, SADD, SPOP, SCARD, SMEMBERS, SSCAN, SREM, SUNION, SUNIONSTORE, SINTER, SINTERSTORE, SISMEMBER, SDIFF, SDIFFSTORE, SMOVE, SRANDMEMBER, BITSET, BITGET, BITCOUNT, BITPOS, BITOP, BITFIELD, PFADD, PFCOUNT, PFMERGE, GEOADD, GEORADIUSBYMEMBER, GEORADIUS, GEOHASH, GEODIST, GEOPOS, XADD, XACK, XGROUP, XDEL, XTRIM, XLEN, XRANGE, XREVRANGE, XCLAIM, XPENDING, XINFO, XREAD, and XREADGROUP Default Value N/A
node_id	No	String	Definition Node ID Constraints N/A Range If this parameter is left blank, all nodes in the instance can be queried. For details about the value, see field id in Table 11. Default Value N/A
keywords	No	Array of strings	Definition Full-text log search based on multiple keywords, indicating that all keywords are matched. Constraints A maximum of 10 keywords are supported. Each keyword can contain a maximum of 512 characters.
max_cost_time	No	Double	Definition Logs can be searched based on the maximum execution duration. The unit is millisecond. Constraints N/A Range N/A Default Value N/A
min_cost_time	No	Double	Definition Logs can be searched based on the minimum execution duration. The unit is millisecond. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
slow_logs	Array of Table 5 objects	Definition Slow log information.

**Table 5** RedisSlowLogDetail
Parameter	Type	Description
node_name	String	Definition Node name Range N/A
node_id	String	Definition Node ID Range N/A
whole_message	String	Definition Statement Range N/A
operate_type	String	Definition Statement type Range N/A
cost_time	Double	Definition Execution time (ms) Range N/A
log_time	String	Definition UTC time when a log is generated. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
line_num	String	Definition Sequence number of a log event. Range N/A

Example Requests

POST
https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/a6d3c8a9857b4c81b3c1fe4802dfa4d0in12/slow-logs

{ 
   "start_time" : "2022-09-06T10:41:14+0800", 
   "end_time" : "2022-09-16T10:41:14+0800", 
   "limit" : 100, 
   "line_num" : "1595659490239433658", 
   "operate_type" : "set", 
   "node_id" : "2997329fe3cb4b3faedcade16df6966eno12", 
   "keywords" : [ "log", "test" ], 
   "max_cost_time" : 100.12, 
   "min_cost_time" : 50.12 
 }

Example Responses

Status code: 200

Success

{ 
  "slow_logs" : [ { 
    "node_name" : "test_priam_node_1", 
    "node_id" : "456265bb2f2a4ea8b344b75fd7842730no12", 
    "whole_message" : "GqKc6_S", 
    "operate_type" : "set", 
    "cost_time" : 60, 
    "log_time" : "2023-01-09T05:42:32+0000", 
    "line_num" : "1595659490239433659" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Logs

Previous topic: Logs

Next topic: Querying Slow Query Logs of a GeminiDB Influx Instance