调用UpdatePipelines,更新Logstash管道信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:UpdatePipelines |
*Logstash
|
无 | 无 |
请求语法
PUT /openapi/logstashes/{InstanceId}/pipelines HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
Logstash 实例 ID。 |
ls-cn-oew1qbgl**** |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| trigger |
boolean |
否 |
是否立即部署。 |
false |
| clientToken |
string |
否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
| body |
string |
否 |
待更新的 Logstash 管道信息列表。 |
[{"pipelineId":"test","config":"input {\n\n}\nfilter {\n\n}\noutput {\n \n}"}] |
RequestBody
RequestBody 中还需填入以下参数,用来指定更新的管道信息。
RequestBody 中需填入 JSON 格式的 pipeline 数组。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
| pipelineId | String | 是 | pipeline-test | 待更新的管道的 ID。 |
| description | String | 否 | this is a test | 管道描述。 |
| config | String | 是 | input { } filter { } output { } | 管道具体配置。 |
| workers | Integer | 否 | 2 | 管道工作线程数。 |
| batchSize | Integer | 否 | 125 | 管道批大小。 |
| batchDelay | Integer | 否 | 50 | 管道批延迟。 |
| queueType | String | 否 | MEMORY | 队列类型,支持:MEMORY、PERSISTED。 |
| pipelineStatus | String | 否 | RUNNING | 管道状态,支持:NOT_DEPLOYED、RUNNING、DELETED。trigger 为 true 时,必填。 |
| queueMaxBytes | Integer | 否 | 1024 | 队列最大字节数。 |
| queueCheckPointWrites | Integer | 否 | 1024 | 队列检查点写入数。 |
示例如下。
[
{
"pipelineId": "test",
"config": "input {\n\n}\nfilter {\n\n}\noutput {\n \n}"
}
]
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Result |
boolean |
返回结果:
|
true |
| RequestId |
string |
请求 ID。 |
5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** |
示例
正常返回示例
JSON格式
{
"Result": true,
"RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。