Call the UpdatePipelineManagementConfig to update the method for managing Logstash pipelines.

Note Pipeline management methods are divided into configuration file management and Kibana pipeline management. Currently, the console no longer supports Kibana pipeline management. You can only use this function through the API.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request header

This operation uses only common request headers. For more information, see Common parameters.

Request syntax

POST /openapi/logstashes/[InstanceId]/pipeline-management-config HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
InstanceId String Yes ls-cn-oew1qbgl****

The ID of the Logstash instance.

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

A unique token generated by the client to guarantee the idempotency of the request. The value of this parameter is generated by the client and is unique among different requests. The maximum length is 64 ASCII characters.

RequestBody

Enter the following parameters in RequestBody to specify the associated Elasticsearch instance information.

Parameter

Type

Required

Example

Description

esInstanceId

String

Yes

es-cn-n6w1o1x0w001c****

The ID of the Elasticsearch instance where Kibana is located after the Kibana management pipeline is enabled.

userName

String

Yes

elastic

The username of Kibana.

password

String

Yes

xxxxxx

The password of Kibana.

pipelineIds

List<String\>

Yes

["testKibanaManagement"]

The list of pipelines managed by Kibana.

endpoints

List<String\>

Yes

["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]

The list of access addresses of Elasticsearch instances where Kibana is located after the Kibana management pipeline is enabled.

pipelineManagementType

String

Yes

ES

The pipeline management method. Valid values: ES(Kibana pipeline management) and MULTIPLE_PIPELINE (configuration file management).

Sample code:

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

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The ID of the request.

Result Boolean true

Returned results:

  • true: update successfully
  • false: update failed

Examples

Sample requests

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipeline-management-config HTTP/1.1
common request header
{
    "pipelineManagementType": "ES",
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "pipelineIds": [
        "testKibanaManagement"
    ],
    "userName": "elastic",
    "password": "xxxx",
    "esInstanceId": "es-cn-n6w1o1x0w001c****"
}

Sample success responses

JSON Syntax

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

Error codes

HttpCode Error code Error message Description
400 InstanceNotFound The instanceId provided does not exist. The error message returned because the instance cannot be found. Check the status of the instance.

For a list of error codes, visit the API Error Center.