Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Querying the Configuration File Content

Updated on 2025-12-26 GMT+08:00

View PDF

Querying the Configuration File Content

Function

This API is used to query the content of a cluster configuration file, including the file name, status, content, and configuration details. You can use the configuration file to define a cluster migration plan and check whether the data sources and destinations are correct.

Calling Method

For details, see Calling APIs.

URI

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

**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
name	Yes	String	Definition: Configuration file name. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
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	setting object	Definition: Configuration content object. Value range: N/A
updateAt	String	Definition: Update time. Value range: N/A
desc	String	Definition: Configuration file description. Value range: It can contain a maximum of 128 characters.

**Table 4** setting
Parameter	Type	Description
workers	Integer	Definition: Number of worker threads that will execute the Filters and Outputs stages of the pipeline in parallel. Constraints: N/A Value range: 1 to 5 times the number of the node's vCPUs Default value: Number of vCPUs.
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. Constraints: N/A Value range: 1-100000 Default value: 125
batch_delay_ms	Integer	Definition: Minimum waiting time of an event to be scheduled by the pipeline. The unit is millisecond. Constraints: N/A Value range: 1-600000 Default value: 50
queue_type	String	Definition: An internal queue for event buffering. Constraints: N/A Value range: memory: a traditional in-memory queue. persisted: a disk-based ACKed persistent queue. Default value: N/A
queue_check_point_writes	Integer	Definition: Maximum number of written events before forcing a checkpoint when persistent queues are enabled. Constraints: This parameter is valid only when queue_type=memory. Value range: 1-40960 Default value: 1024
queue_max_bytes_mb	Integer	Definition: Total capacity (in MB) of a persistent queue if persistent queues are used. Make sure the disk capacity is greater than the value of this parameter. Constraints: This parameter is valid only when queue_type=memory. Value range: 1-100000 Default value: 1024

Example Requests

Query the configuration file content.

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/lgsconf/confdetail?name=conf1

Example Responses

Status code: 200

Request succeeded.

{
  "name" : "conf",
  "desc" : "This is a description of a configuration file.",
  "status" : "available",
  "confContent" : "xxxxxxxx",
  "setting" : {
    "workers" : 2
  },
  "updateAt" : "2021-09-29T02:44:44"
}

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.