更新时间:2024-12-11 GMT+08:00
分享

查询慢日志

功能介绍

获取内核慢日志信息。

调用方法

请参见如何调用API

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"
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

获取内核慢日志信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class ShowClickHouseSlowLogDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowClickHouseSlowLogDetailRequest request = new ShowClickHouseSlowLogDetailRequest();
        request.withInstanceId("{instance_id}");
        ChSlowLogQueryRequestBody body = new ChSlowLogQueryRequestBody();
        body.withDatabase("DBS_NODE");
        body.withOperateType("All");
        body.withLineNum("1669344916000");
        body.withLimit(10);
        body.withEndTime("2023-12-12T02:14:27+0100");
        body.withStartTime("2023-12-12T00:14:27+0100");
        body.withNodeId("aeb9e81135b34197bab8636fc8a1c569no16");
        request.withBody(body);
        try {
            ShowClickHouseSlowLogDetailResponse response = client.showClickHouseSlowLogDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

获取内核慢日志信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowClickHouseSlowLogDetailRequest()
        request.instance_id = "{instance_id}"
        request.body = ChSlowLogQueryRequestBody(
            database="DBS_NODE",
            operate_type="All",
            line_num="1669344916000",
            limit=10,
            end_time="2023-12-12T02:14:27+0100",
            start_time="2023-12-12T00:14:27+0100",
            node_id="aeb9e81135b34197bab8636fc8a1c569no16"
        )
        response = client.show_click_house_slow_log_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

获取内核慢日志信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowClickHouseSlowLogDetailRequest{}
	request.InstanceId = "{instance_id}"
	databaseChSlowLogQueryRequestBody:= "DBS_NODE"
	operateTypeChSlowLogQueryRequestBody:= "All"
	lineNumChSlowLogQueryRequestBody:= "1669344916000"
	request.Body = &model.ChSlowLogQueryRequestBody{
		Database: &databaseChSlowLogQueryRequestBody,
		OperateType: &operateTypeChSlowLogQueryRequestBody,
		LineNum: &lineNumChSlowLogQueryRequestBody,
		Limit: int32(10),
		EndTime: "2023-12-12T02:14:27+0100",
		StartTime: "2023-12-12T00:14:27+0100",
		NodeId: "aeb9e81135b34197bab8636fc8a1c569no16",
	}
	response, err := client.ShowClickHouseSlowLogDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档