Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Adding a Custom Template
Updated on 2025-12-26 GMT+08:00
View PDF

Adding a Custom Template

Function

This API is used to add a custom template.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/favorite

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 where a custom template is to be added. 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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Configuration file name.

template

Yes

AddFavoriteReqTemplate object

Custom template entity object.
Table 3 AddFavoriteReqTemplate

Parameter

Mandatory

Type

Description

templateName

Yes

String

Custom template name. The value can contain 4 to 32 characters. It must start with a letter and can contain only letters, digits, hyphens (-), and underscores (_).

desc

No

String

Template description. The value can contain a maximum of 256 characters.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Configure a user-defined template.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/favorite

{
  "name" : "conf1",
  "template" : {
    "templateName" : "template1",
    "desc" : "Custom template"
  }
}

Example Responses

None

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.

Parent topic: Logstash