Updates the management method of pipelines in a Logstash cluster.
Debugging
Request headers
This operation uses only common request headers and does not have operation-specific request headers. For more information, see the "Common request parameters" section of the "Common parameters" topic.
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 instance. |
clientToken | String | Query | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. |
Object | Body | No |
The information about the associated Elasticsearch instance. |
||
endpoints | Array of String | Body | No | ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"] |
After the Kibana management pipeline is enabled, the endpoint list of the Elasticsearch instance where Kibana is located. |
userName | String | Body | No | elastic |
The username that is used to log on to Kibana. |
password | String | Body | No | ****** |
The password used to log on to Kibana. |
pipelineIds | Array of String | Body | No | ["testKibanaManagement"] |
The list of pipelines managed by Kibana. |
pipelineManagementType | String | Body | No | ES |
The pipeline management mode. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Result | Boolean | true |
Returned results:
|
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 response
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, visit the API Error Center.