UpdatePipelineManagementConfig - Elasticsearch

說明管道管理方式分為設定檔管理和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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。