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.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/listconfs
| 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 |
| 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
| Parameter | Type | Description |
|---|---|---|
| confs | Array of ListConfsRespConfs objects | Definition Configuration file list. |
| totalSize | Integer | Definition Total number of configuration files. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Configuration file name. Range N/A |
| status | String | Definition Configuration file status. Range |
| confContent | String | Definition Configuration file content. Range N/A |
| setting | ListConfsRespConfsSetting object | Definition Configuration content object. |
| updateAt | String | Definition Update time, in the format yyyy-MM-dd'T'HH:mm:ss. Range N/A |
| desc | String | Definition Configuration file description. Range Up to 128 characters. |
| sensitiveWordsShielding | Boolean | Definition Whether to hide sensitive words. Range |
| Parameter | Type | Description |
|---|---|---|
| workers | Integer | Definition Number of worker threads that execute the Filters and Outputs phase of the pipeline in parallel. Range N/A |
| batchSize | Integer | Definition Maximum number of events collected from inputs by a single worker thread before executing its filters and outputs. Increasing this value increases memory overhead. Range 1 to 100000 |
| batchDelayMs | Integer | Definition Minimum wait time before an event is scheduled by the pipeline, in milliseconds. Range 1 to 600000 |
| queueType | String | Definition An internal queue for event buffering. Range |
| queueCheckPointWrites | Integer | Definition Maximum number of written events before forcing a checkpoint when persistent queues are enabled. Range 1 to 100000 |
| queueMaxBytesMb | 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-10240 |
Example Requests
Query the configuration file list.
GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/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
} 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.