UpdatePipelines - 更新Logstash管道信息

更新时间:
复制 MD 格式

调用UpdatePipelines,更新Logstash管道信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdatePipelines

*Logstash

acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}

无 无

请求语法

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 数组。

名称类型是否必选示例值描述
pipelineIdString是pipeline-test待更新的管道的 ID。
descriptionString否this is a test管道描述。
configString是input { } filter { } output { }管道具体配置。
workersInteger否2管道工作线程数。
batchSizeInteger否125管道批大小。
batchDelayInteger否50管道批延迟。
queueTypeString否MEMORY队列类型,支持:MEMORY、PERSISTED。
pipelineStatusString否RUNNING管道状态,支持:NOT_DEPLOYED、RUNNING、DELETED。trigger 为 true 时,必填。
queueMaxBytesInteger否1024队列最大字节数。
queueCheckPointWritesInteger否1024队列检查点写入数。

示例如下。

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

返回参数

名称

类型

描述

示例值

object

Result

boolean

返回结果:

  • true:更新成功

  • false:更新失败

true

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

示例

正常返回示例

JSON格式

{
  "Result": true,
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。