更新时间:2025-08-15 GMT+08:00

查询日志

功能介绍

云搜索服务提供日志备份与日志查询功能,帮助用户高效定位问题。用户可通过日志备份定期将集群日志持久化存储至OBS对象存储桶,从而实现日志长期管理与按需下载,便于问题溯源与合规审计;同时支持通过接口直接查询集群日志信息,能够根据节点名称、日志级别等条件精准检索指定时间段的运行日志,快速定位异常或性能瓶颈。该接口通过指定节点名称、日志级别、日志类型,查询日志信息。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/logs/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待查询集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_name

String

参数解释

节点名称。通过查询集群详情获取instances中的name属性。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

level

String

参数解释

查询的日志级别。

约束限制

不涉及

取值范围

  • DEBUG:查询DEBUG级别的日志。

  • INFO:查询INFO级别的日志。

  • WARN:查询WARN级别的日志。

  • ERROR:查询ERROR级别的日志。

  • ALL: 所有日志级别。

默认取值

ALL

log_type

String

参数解释

查询的日志类型。

约束限制

不涉及

取值范围

  • deprecation:查询废弃操作日志。

  • indexingSlow:查询慢索引日志。

  • searchSlow:查询慢查询日志。

  • instance:查询运行日志。

默认取值

不涉及

limit

Integer

参数解释

指定返回日志的条数,默认返回100条,最大返回10000条日志,且日志大小不超过1MB。

约束限制

不涉及

取值范围

1-10000

默认取值

100

time_index

String

参数解释

返回指定时间之前的日志。

约束限制

时间格式为yyyy-MM-ddTHH:mm:ss,SSS。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

logList

Array of logList objects

参数解释

日志列表。

取值范围

不涉及

表4 logList

参数

参数类型

描述

content

String

参数解释

日志内容。

取值范围

不涉及

date

String

参数解释

日志产生日期。

取值范围

不涉及

level

String

参数解释

日志级别。

取值范围

  • DEBUG:查询DEBUG级别的日志。

  • INFO:查询INFO级别的日志。

  • WARN:查询WARN级别的日志。

  • ERROR:查询ERROR级别的日志。

请求示例

根据节点名称、日志级别和日志类型,查询日志信息。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/search

{
  "instance_name" : "css-4312-ess-esn-1-1",
  "level" : "INFO",
  "log_type" : "instance"
}

响应示例

状态码:200

请求已成功。

{
  "logList" : [ {
    "content" : "xxxxxx",
    "date" : "2021-10-08T03:55:54,718",
    "level" : "INFO"
  } ]
}

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
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.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;


public class ShowLogBackupSolution {

    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);

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowLogBackupRequest request = new ShowLogBackupRequest();
        request.withClusterId("{cluster_id}");
        GetLogBackupReq body = new GetLogBackupReq();
        body.withLogType("instance");
        body.withLevel("INFO");
        body.withInstanceName("css-4312-ess-esn-1-1");
        request.withBody(body);
        try {
            ShowLogBackupResponse response = client.showLogBackup(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 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 = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowLogBackupRequest()
        request.cluster_id = "{cluster_id}"
        request.body = GetLogBackupReq(
            log_type="instance",
            level="INFO",
            instance_name="css-4312-ess-esn-1-1"
        )
        response = client.show_log_backup(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/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 := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowLogBackupRequest{}
	request.ClusterId = "{cluster_id}"
	request.Body = &model.GetLogBackupReq{
		LogType: "instance",
		Level: "INFO",
		InstanceName: "css-4312-ess-esn-1-1",
	}
	response, err := client.ShowLogBackup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码