Querying the Configuration File List

Function

This API is used to query the configuration file list.

Calling Method

For details, see Calling APIs.

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 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
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: 1-1000 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	Configuration file list.

**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	setting object	Definition: Configuration content object. Value range: N/A
updateAt	String	Definition: Update time. Value range: N/A

**Table 5** 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: N/A Default value: Number of CPU cores.
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: N/A 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: N/A Default value: N/A
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: N/A Value range: N/A 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: N/A Value range: N/A Default value: 1024

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" : "conf1",
    "status" : "available",
    "confContent" : "xxxxxxxx",
    "setting" : {
      "workers" : 2,
      "batchSize" : 125,
      "batchDelayMs" : 50,
      "queueType" : "persisted",
      "queueCheckPointWrites" : 1024,
      "queueMaxBytesMb" : 1024
    },
    "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.