全部产品
Search
文档中心

检索分析服务Elasticsearch版:UpdatePipelineManagementConfig

更新时间:Jul 04, 2024

修改指定Logstash实例的管道管理方式。

说明 管道管理方式分为配置文件管理和Kibana管道管理,目前控制台已不支持Kibana管道管理,仅可通过API使用此功能。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/logstashes/{InstanceId}/pipeline-management-config HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

InstanceId String Path ls-cn-oew1qbgl****

Logstash实例ID。

clientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B3FF****

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

Object Body

关联的Elasticsearch实例信息。

endpoints Array of String Body ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]

开启Kibana管理管道后,Kibana所在Elasticsearch实例的访问地址列表。

userName String Body elastic

登录Kibana的用户名。

password String Body ******

登录Kibana的密码。

pipelineIds Array of String Body ["testKibanaManagement"]

Kibana管理的管道列表。

pipelineManagementType String Body ES

管道管理方式,可选值:

  • ES:Kibana管道管理
  • MULTIPLE_PIPELINE:配置文件管理

返回数据

名称

类型

示例值

描述

Result Boolean true

返回结果:

  • true:更新成功
  • false:更新失败
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

示例

请求示例

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipeline-management-config?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
    "pipelineManagementType": "ES",
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "pipelineIds": [
        "testKibanaManagement"
    ],
    "userName": "elastic",
    "password": "xxxx"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "135E9F19-277D-4E34-85AC-EB394AA2****"
}

错误码

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