查询GeminiDB Influx数据库慢日志 - QueryingSlowQueryLogsofaGeminiDBInfluxInstance
功能介绍
查询GeminiDB Influx数据库慢日志信息,支持日志关键字搜索。
接口约束
- 不支持使用 &&、||、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
-
URI
POST /v3/{project_id}/influxdb/instances/{instance_id}/slow-logs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID,可以调用查询实例列表和详情 - QueryingInstancesandDetails接口获取。如果未申请实例,可以调用创建实例 - CreatinganInstance接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_time | 是 | String | 参数解释: 开始时间。 约束限制: 开始时间不得早于当前时间30天。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。 |
| end_time | 是 | String | 参数解释: 结束时间。 约束限制: 结束时间不能晚于当前时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。 |
| limit | 是 | Integer | 参数解释: 表示每次查询的日志条数。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 不涉及。 |
| line_num | 否 | String | 参数解释: 日志单行序列号,当次查询从line_num的下一条日志开始查询,不包含当前line_num日志。 约束限制: 第一次查询时不需要此参数,下一次查询时需要使用,可从上一次查询的返回信息中获取。 取值范围: 不涉及。 默认取值: 不涉及。 |
| operate_type | 否 | String | 参数解释: 语句类型。 约束限制: 不涉及。 取值范围:
默认取值: 不传入该参数表示查询所有语句类型。 |
| node_id | 否 | String | 参数解释: 节点ID。具体取值请参考表10中的“id”。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不传入该参数表示查询实例下所有允许查询的节点。 |
| keywords | 否 | String | 参数解释: 根据多个关键字搜索日志全文,表示同时匹配所有关键字。 约束限制: 最多支持10个关键字。 每个关键字最大长度不超过512个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| max_cost_time | 否 | Integer | 参数解释: 支持根据最大执行时间范围查找日志。单位:ms 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| min_cost_time | 否 | Integer | 参数解释: 支持根据最小执行时间范围查找日志。单位:ms 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| database | 否 | String | 参数解释: 数据库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| retention_policy | 否 | String | 参数解释: 保留策略。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| slow_logs | Array of 表5 objects | 参数解释: Influxdb慢日志列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| node_id | String | 参数解释: 节点ID。 取值范围: 不涉及。 |
| node_name | String | 参数解释: 节点名称。 取值范围: 不涉及。 |
| whole_message | String | 参数解释: 执行语句。 取值范围: 不涉及。 |
| operate_type | String | 参数解释: 语句类型。 取值范围:
|
| cost_time | String | 参数解释: 执行时间。单位:ms 取值范围: 不涉及。 |
| log_time | String | 参数解释: 日志产生时间,UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 |
| database | String | 参数解释: 数据库名称。 取值范围: 不涉及。 |
| retention_policy | String | 参数解释: 保留策略。 取值范围: 不涉及。 |
| line_num | String | 参数解释: 日志单行序列号。 取值范围: 不涉及。 |
请求示例
查询2023-07-06 10:41:14~2023-07-10 10:41:14的100条select慢日志。
POST https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/influxdb/instances/4466bd981011413cb98514e1cc20fdb0in13/slow-logs
{
"start_time" : "2023-07-06T10:41:14+0800",
"end_time" : "2023-07-10T10:41:14+0800",
"limit" : 100,
"line_num" : "1595659490239433658",
"operate_type" : "SELECT",
"node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no13",
"max_cost_time" : 100,
"min_cost_time" : 50,
"database" : "dbname" ,
"retention_policy" : "monitor"
} 响应示例
状态码: 200
Success
{
"slow_logs" : [ {
"node_name" : "test_priam_node_1",
"node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no13",
"whole_message" : "SELECT tag,field FROM dbname..mst WHERE time >= '1' AND time < '2'",
"operate_type" : "SELECT",
"cost_time" : 60,
"log_time" : "2023-07-04T05:42:32.000+0000",
"database" : "dbname",
"line_num" : "1595659490239433659",
"retention_policy" : "monitor"
} ]
} 状态码
请参见状态码。
错误码
请参见错误码。