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

查询日志基础配置

功能介绍

该接口用于查询集群日志备份或日志实时采集的基础配置。如果集群打开过日志备份或者日志采集的功能开关,那可以通过该接口分别查询日志备份的基础配置和日志采集的基础配置。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

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

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

action

String

参数解释

查询集群日志备份或者日志采集的配置。

约束限制

不涉及

取值范围

  • base_log_collect:查询集群日志备份的配置。

  • real_time_log_collect:查询集群日志实时采集的配置。

默认取值

base_log_collect

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

logConfiguration

logConfiguration object

参数解释

日志备份的配置。

取值范围

不涉及

realTimeLogCollectRecord

realTimeLogCollect object

参数解释

日志实时采集的配置。

取值范围

不涉及

表4 logConfiguration

参数

参数类型

描述

id

String

参数解释

日志备份ID,通过系统UUID生成。

取值范围

不涉及

clusterId

String

参数解释

集群ID。

取值范围

不涉及

obsBucket

String

参数解释

用于存储日志的OBS桶的桶名。

取值范围

不涉及

agency

String

参数解释

委托名称,委托给CSS,允许CSS调用您的其他云服务。

取值范围

不涉及

updateAt

Long

参数解释

更新时间。

取值范围

格式为ISO8601:CCYY-MM-DDThh:mm:ss。

basePath

String

参数解释

日志在OBS桶中的备份路径。

取值范围

不涉及

autoEnable

Boolean

参数解释

是否开启自动备份开关。

取值范围

  • true: 开启自动备份开关。

  • false: 关闭自动备份开关。

period

String

参数解释

自动备份日志开始时间。

取值范围

格式为:格林威治标准时间(GMT)。当autoEnable为false时该字段为null。

logSwitch

Boolean

参数解释

是否开启日志开关。

取值范围

  • true: 开启日志开关。

  • false: 关闭日志开关。

表5 realTimeLogCollect

参数

参数类型

描述

id

String

参数解释

日志采集ID,通过系统UUID生成。

取值范围

不涉及

clusterId

String

参数解释

集群ID。

取值范围

不涉及

indexPrefix

String

参数解释

日志保存索引的前缀。

取值范围

不涉及

keepDays

Integer

参数解释

日志保存时间。

取值范围

不涉及

targetClusterId

String

参数解释

保存日志的目标集群ID。

取值范围

不涉及

status

String

参数解释

日志实时采集任务状态。

取值范围

  • 100:正在创建日志实时采集任务。

  • 150:日志实时采集可用。

  • 200:日志实时采集任务激活。

  • 300:日志实时采集失败。

  • 302:日志实时采集失败删除。

  • 303:日志实时采集任务创建失败。

  • 304:日志实时采集任务关闭中。

  • 400:日志实时采集任务已经关闭。

createAt

Long

参数解释

日志实时采集任务开启时间。

取值范围

不涉及

updateAt

Long

参数解释

日志实时采集任务更新时间。

取值范围

不涉及

请求示例

  • 查询集群日志备份的配置。

    GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=base_log_collect
  • 查询集群日志实时采集的配置。

    GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=real_time_log_collect

响应示例

状态码:200

请求已成功。

  • 查询集群日志备份的配置响应示例。

    {
      "realTimeLogCollectRecord" : {
        "id" : "17939b7b-5a93-4ca5-8d3c-b9f2d0e715b4",
        "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20",
        "keepDays" : 30,
        "updateAt" : 1717666418870,
        "createAt" : 1717666405897,
        "targetClusterId" : "8c19644b-f2ef-44fc-abef-230a4c578ce7",
        "indexPrefix" : "aaa",
        "status" : "200"
      }
    }
  • 查询集群日志实时采集的配置响应示例。

    {
      "logConfiguration" : {
        "id" : "00032118-aff5-40e8-b19a-dd4bb576e572",
        "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20",
        "obsBucket" : "css-autobk-notdel-cn-north-7",
        "agency" : "css_obs_agency",
        "updateAt" : 1639624882000,
        "basePath" : "css/log",
        "autoEnable" : false,
        "logSwitch" : false
      }
    }

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
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 ShowGetLogSettingSolution {

    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();
        ShowGetLogSettingRequest request = new ShowGetLogSettingRequest();
        request.withClusterId("{cluster_id}");
        try {
            ShowGetLogSettingResponse response = client.showGetLogSetting(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
# 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 = ShowGetLogSettingRequest()
        request.cluster_id = "{cluster_id}"
        response = client.show_get_log_setting(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
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.ShowGetLogSettingRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ShowGetLogSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码