Call the UpdatePipelines to update the Logstash pipeline information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request header

This operation uses only common request headers. For more information, see Common parameters.

Request syntax

PUT /openapi/logstashes/[InstanceId]/pipelines HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
clientToken String Yes 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. The value of this parameter is generated by the client and is unique among different requests. The maximum length is 64 ASCII characters.

InstanceId String Yes ls-cn-oew1qbgl****

The ID of the Logstash instance.
trigger Boolean No false

Indicates whether to deploy immediately.

RequestBody

To specify the updated pipeline information, you must enter the following parameters in RequestBody:

Note The pipeline array in JSON format must be filled in RequestBody.

Parameter

Type

Required

Example

Description

pipelineId

String

Yes

pipeline-test

The ID of the pipeline to update.

description

String

No

this is a test

The description of the pipeline.

config

String

Yes

input { } filter { } output { }

The specific configuration of the pipeline.

workers

Integer

No

2

The number of pipeline workers.

batchSize

Integer

No

125

Pipeline batch size.

batchDelay

Integer

No

50

Pipeline batch delay.

queueType

String

No

MEMORY

The type of the queue. Valid values: MEMORY and PERSISTED.

pipelineStatus

String

No

RUNNING

The status of the pipeline. Valid values: NOT_DEPLOYED, RUNNING, and DELETED. This parameter is required when the trigger parameter is set to true.

queueMaxBytes

Integer

No

1024

The maximum number of bytes in the queue.

queueCheckPointWrites

Integer

No

1024

The number of queue checkpoint writes.

Sample code:

[
    {
        "pipelineId": "test",
        "config": "input {\n\n}\nfilter {\n\n}\noutput {\n \n}"
    }
]

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The ID of the request.
Result Boolean true

Returned results:

  • true: update succeed
  • false: update failed

Examples

Sample requests

PUT /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&trigger=false HTTP/1.1
common request header
[
{"pipelineId":"test", "config":"input {\n\n}\nfilter {\n\n}\noutput {\n \n}"},

{"pipelineId":"test1", "config":"input {\n\n}\nfilter {\n\n}\noutput {\n  \n}"}
]

Sample success responses

XML format 

<Result>true</Result>
<RequestId>734F9DEC-74AC-4D6E-B97F-FFDAA90B****</RequestId>

JSON Syntax 

{
    "Result": true,
    "RequestId": "734F9DEC-74AC-4D6E-B97F-FFDAA90B****"
}

Error code

For a list of error codes, visit the API Error Center.