Help Center/ Cloud Search Service/ API Reference/ API V1/ Log Management/ Querying Basic Log Configurations
Updated on 2025-08-15 GMT+08:00

Querying Basic Log Configurations

Function

This API is used to query the basic configuration of cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the cluster, you can use this API to query the basic configurations of log backup and log collection.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

No

String

Parameter description:

Queries the log backup or log collection settings of a cluster.

Constraints:

N/A

Options:

  • base_log_collect: Queries cluster log backup settings.

  • real_time_log_collect: Queries cluster log collection settings.

Default value:

base_log_collect

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

logConfiguration

logConfiguration object

Parameter description:

Log backup configuration.

Options:

N/A

realTimeLogCollectRecord

realTimeLogCollect object

Parameter description:

Real-time log ingestion configuration.

Options:

N/A

Table 4 logConfiguration

Parameter

Type

Description

id

String

Parameter description:

Log backup ID, which is generated using the system UUID.

Options:

N/A

clusterId

String

Parameter description:

Cluster ID.

Options:

N/A

obsBucket

String

Parameter description:

Name of the OBS bucket for storing logs.

Options:

N/A

agency

String

Parameter description:

Agency name. You can create an agency to allow CSS to call other cloud services.

Options:

N/A

updateAt

Long

Definition:

Update time.

Value range:

The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

basePath

String

Parameter description:

Storage path of backed up logs in the OBS bucket.

Options:

N/A

autoEnable

Boolean

Definition:

Whether to enable automatic backup.

Value range:

  • true: Enable automatic backup.

  • false: Disable automatic backup.

period

String

Definition:

Start time of automatic log backup.

Value range:

Format: Greenwich Mean Time (GMT). When autoEnable is set to false, the value of this parameter is null.

logSwitch

Boolean

Definition:

Whether to enable logging.

Value range:

  • true: Enable logging.

  • false: Disable logging.

Table 5 realTimeLogCollect

Parameter

Type

Description

id

String

Parameter description:

Log collection ID, which is generated using the system UUID.

Options:

N/A

clusterId

String

Definition:

Cluster ID

Value range:

N/A

indexPrefix

String

Parameter description:

Prefix of the index for saving logs.

Options:

N/A

keepDays

Integer

Parameter description:

Log retention duration.

Options:

N/A

targetClusterId

String

Parameter description:

ID of the target cluster where logs are saved.

Options:

N/A

status

String

Definition:

Status of a real-time log ingestion task.

Value range:

  • 100: A real-time log ingestion task is being created.

  • 150: Real-time log ingestion is available.

  • 200: The real-time log ingestion task is activated.

  • 300: Real-time log ingestion failed.

  • 302: The real-time log ingestion task failed to be deleted.

  • 303: The real-time log ingestion task failed to be created.

  • 304: The real-time log ingestion task is being disabled.

  • 400: The real-time log ingestion task is disabled.

createAt

Long

Parameter description:

Start time of a real-time log collection task.

Options:

N/A

updateAt

Long

Parameter description:

Update time of a real-time log collection task.

Options:

N/A

Example Requests

  • Query the cluster's log backup settings.

    GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=base_log_collect
  • Query the cluster's log ingestion settings.

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

Example Responses

Status code: 200

Request succeeded.

  • Example response to a request to query the cluster's log backup settings.

    {
      "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"
      }
    }
  • Example response to a request to query the cluster's log ingestion settings.

    {
      "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 Sample Code

The SDK sample code is as follows.

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

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

409

The request could not be completed due to a conflict with the current state of the resource.

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.