Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Querying the Template List

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

View PDF

Querying the Template List

Function

This API is used to query the template list.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/lgsconf/template

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition: Template type. Constraints: N/A Value range: custom: custom template. system: system template. Default value: Search for custom and system templates.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
systemTemplates	Array of systemTemplates objects	System template list.
customTemplates	Array of customTemplates objects	Custom template list.

**Table 4** systemTemplates
Parameter	Type	Description
id	String	Configuration file ID.
name	String	Configuration file name.
confContent	String	Configuration file content.
desc	String	Description.

**Table 5** customTemplates
Parameter	Type	Description
id	String	Configuration file ID.
name	String	Configuration file name.
confContent	String	Configuration file content.
desc	String	Description.

Example Requests

Query the template list.

GET https://{Endpoint}/v1.0/{project_id}/clusters/lgsconf/template?type=custom

Example Responses

Status code: 200

Request succeeded.

{
  "systemTemplates" : [ {
    "id" : "a03b1791-6dc6-453d-961d-88939adc82aa",
    "name" : "elasticsearch",
    "confContent" : "xxxxxxxx",
    "desc" : "logstash config for es"
  } ],
  "customTemplates" : [ {
    "id" : "2e16fbba-49bf-4690-93af-3f89025c6523",
    "name" : "es_to_https_es",
    "confContent" : "xxxxxxxx",
    "desc" : "From ES to an ES security cluster"
  } ]
}

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.