Updates the configuration of a specified Logstash cluster.

When you call this operation, take note of the following items:

If the instance is in the Active (activating), Invalid (invalid), and Inactive (inactive) state, the information cannot be updated.


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 codes.

Request parameters

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

Request structure

PATCH|POST /openapi/logstashes/[InstanceId]/instance-settings HTTP/1.1

Request parameters

Parameter Type Location Required Example Description
InstanceId String Path Yes ls-cn-2r42btxr****

The ID of the instance.

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

This parameter is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.


You must specify the following parameters in RequestBody to update the configurations of a specified Logstash instance.










Used to update the YML configuration information of an instance.

Response parameters

Parameter Type Example Description
RequestId String 71D0D1DA-B22F-58CB-AF5B-D1657A6A****

The ID of the request.

The returned data also contains the Result parameter. For more information about the parameter, see ListLogstash.


Sample requests

PATCH /openapi/logstashes/ls-cn-2r42btxr****/instance-settings HTTP/1.1
Common request headers

Sample success responses

JSON format

    "Result": {
        "instanceId": "ls-cn-2r42btxr****",
        "version": "7.4.0_with_X-Pack",
        "description": "lrr",
        "nodeAmount": 1,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 20,
            "diskType": "cloud_efficiency"
        "dataNode": true,
        "networkConfig": {
            "vpcId": "vpc-bp1jy348ibzulk6hn****",
            "vswitchId": "vsw-bp1a0mifpletdd1da****",
            "vsArea": "cn-hangzhou-h",
            "whiteIpGroupList": [],
            "type": "vpc"
        "createdAt": "2021-08-30T08:28:21.976Z",
        "updatedAt": "2021-08-30T08:59:06.371Z",
        "commodityCode": "elasticsearch_logstash_post",
        "extendConfigs": [],
        "endTime": 4786012800000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfmxxkk2p7****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
                "zoneId": "cn-hangzhou-h",
                "status": "NORMAL"
        "instanceType": "logstash",
        "inited": true,
        "tags": [
                "tagKey": "acs:rm:rgId",
                "tagValue": "rg-acfmxxkk2p7****"
        "serviceVpc": false,
        "isNewDeployment": false,
        "config": {
            "xpack.monitoring.enabled": "true",
            "xpack.monitoring.elasticsearch.username": "elastic",
            "slowlog.threshold.debug": "500ms",
            "xpack.monitoring.elasticsearch.hosts": "[\"http://es-cn-7pp2bvb75005u****.elasticsearch.aliyuncs.com:9200\"]",
            "xpack.monitoring.elasticsearch.password": "*******",
            "slowlog.threshold.warn": "2s",
            "slowlog.threshold.info": "1s",
            "slowlog.threshold.trace": "100ms"
        "endpointList": [
                "host": "172.29.XX.XX",
                "port": 9600,
                "zoneId": "cn-hangzhou-h"
    "RequestId": "71D0D1DA-B22F-58CB-AF5B-D1657A6A****"

Error codes

HttpCode Error code Error message Description
400 InstanceActivating Instance is activating. The instance is currently in effect.
400 InstanceNotFound The instanceId provided does not exist. The instance cannot be found. Check the instance status.

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