UpdatePipelineManagementConfig - Elasticsearch - Alibaba Cloud Documentation Center

Note You can manage pipelines by using the following methods: profile management and Kibana pipeline management. Kibana pipeline management is not supported in the console. You can use this feature only by calling API operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

The DescribeEniMonitorData operation does not have operation-specific request headers and uses only common request headers. For more information, refer to the documentation of common request parameters.

Request syntax

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

Request parameters

Parameter	Type	Position	Required	Example	Description
InstanceId	String	Path	Yes	ls-cn-oew1qbgl****	The ID of the Logstash cluster.
clientToken	String	Query	No.	5A2CFF0E-5718-45B5-9D4D-70B3FF****	that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
	Object	Body	No		The information about the associated Elasticsearch cluster.
endpoints	Array of String	Body	No	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	The access addresses of the Elasticsearch cluster that provide the Kibana service after you enable Kibana-based pipeline management.
userName	String	Body	No	elastic	The username that is used to log on to the Kibana console.
password	String	Body	No	******	The password that is used to log on to the Kibana console.
pipelineIds	Array of String	Body	No	["testKibanaManagement"]	The pipelines that you want to manage by using Kibana.
pipelineManagementType	String	Body	No	ES	The pipeline management method. Valid values: ES: Kibana-based pipeline management MULTIPLE_PIPELINE: configuration file-based pipeline management

Response parameters

Parameter

Type

Sample value

Description

Result

Boolean

true

The following result is returned:

true: The update was successful.
false: The update failed.

RequestId

String

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

The ID of the request.

Examples

Sample requests

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"
}

Sample success responses

JSON format

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

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

Error codes

For a list of error codes, see Service error codes.