Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Querying the Configuration File List
Updated on 2026-08-10 GMT+08:00

Querying the Configuration File List

Function

This API is used to query the configuration file list of a Logstash cluster.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    css:logstash:listConfs

    List

    cluster *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/listconfs

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

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

ID of the cluster to be queried. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

N/A

Range

The value is a UUID containing 36 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition:

The start value of the query. The default value is 1, indicating that the query starts from the first configuration.

Constraints:

N/A

Value range:

Greater than or equal to 1.

Default value:

1

limit

No

Integer

Definition:

Number of configurations to be queried. The default value is 10, indicating that 10 configurations are queried at a time.

Constraints:

N/A

Value range:

1-1000

Default value:

10

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

confs

Array of confs objects

Definition

Configuration file list.

totalSize

Integer

Definition

Total number of configuration files.

Range

N/A

Table 4 confs

Parameter

Type

Description

name

String

Definition:

Configuration file name.

Value range:

N/A

status

String

Definition:

Configuration file status.

Value range:

  • checking

  • available

  • unavailable

  • starting

  • working

  • stopping

  • stopped

  • restoring

confContent

String

Definition:

Configuration file content.

Value range:

N/A

setting

settingResponse object

Definition

Configuration content object.

updateAt

String

Definition

Update time, in the yyyy-MM-dd'T'HH:mm:ss format.

Range

N/A

desc

String

Definition

Configuration file description.

Range

The value can contain at most 128 characters.

auto_enable:

sensitiveWordsShielding

Boolean

Definition

Whether to hide sensitive words.

Range

  • true: Sensitive words are hidden.

  • false: Sensitive words are not hidden.

Table 5 settingResponse

Parameter

Type

Description

workers

Integer

Definition

Number of worker threads that will execute the Filters and Outputs stages of the pipeline in parallel.

Range

N/A

batch_size

Integer

Definition

Maximum number of events that a worker thread collects from inputs before attempting to execute its filters and outputs. A larger value is more effective but increases memory overhead.

Range

1-100000

batch_delay_ms

Integer

Definition

Minimum waiting time of an event to be scheduled by the pipeline, in milliseconds.

Range

1-600000

queue_type

String

Definition

An internal queue for event buffering.

Range

  • memory: a traditional in-memory queue.

  • **persisted: a disk-based ACKed persistent queue.

queue_check_point_writes

Integer

Definition

Maximum number of written events before forcing a checkpoint when persistent queues are enabled.

Range

1-40960

queue_max_bytes_mb

Integer

Definition

Total capacity (in MB) of a persistent queue if persistent queues are used. Ensure that the disk capacity is greater than the value of this parameter.

Range

1-100000

Example Requests

Query the configuration file list.

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/lgsconf/listconfs

Example Responses

Status code: 200

Request succeeded.

{
  "confs" : [ {
    "name" : "conf",
    "desc" : "This is a description of a configuration file.",
    "status" : "available",
    "confContent" : "xxxxxxxx",
    "setting" : {
      "workers" : 2,
      "batchSize" : 125,
      "batchDelayMs" : 50,
      "queueType" : "memory",
      "queueCheckPointWrites" : 1024,
      "queueMaxBytesMb" : 1024
    },
    "updateAt" : "2021-09-29T02:44:44",
    "sensitiveWordsShielding" : false
  } ],
  "totalSize" : 1
}

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

    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();
        ListConfsRequest request = new ListConfsRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListConfsResponse response = client.listConfs(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 = ListConfsRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_confs(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"
    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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := css.CssClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := css.NewCssClient(hcClient)

    request := &model.ListConfsRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListConfs(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.

The client should modify the request instead of re-initiating it.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

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

Error Codes

See Error Codes.