UpdatePipelines_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:UpdatePipelines
Write
Logstash
acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}

请求语法

PUT /openapi/logstashes/{InstanceId}/pipelines HTTP/1.1

路径参数

字段名称字段详情
InstanceIdstring

Logstash 实例 ID。

示例值:ls-cn-oew1qbgl****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
triggerboolean

是否立即部署。

示例值:false
clientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

RequestBody

RequestBody 中还需填入以下参数,用来指定更新的管道信息。

说明 RequestBody 中需填入 JSON 格式的 pipeline 数组。
名称类型是否必选示例值描述
pipelineIdStringpipeline-test待更新的管道的 ID。
descriptionStringthis is a test管道描述。
configStringinput { } filter { } output { }管道具体配置。
workersInteger2管道工作线程数。
batchSizeInteger125管道批大小。
batchDelayInteger50管道批延迟。
queueTypeStringMEMORY队列类型,支持:MEMORY、PERSISTED。
pipelineStatusStringRUNNING管道状态,支持:NOT_DEPLOYED、RUNNING、DELETED。trigger 为 true 时,必填。
queueMaxBytesInteger1024队列最大字节数。
queueCheckPointWritesInteger1024队列检查点写入数。

示例如下。

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

返回参数

字段名称字段详情
Resultboolean

返回结果:展开详情

示例值:true
RequestIdstring

请求 ID。

示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

返回示例

变更历史

变更时间变更内容概要操作
2022-08-30
删除错误码400
删除错误码401

相关示例