Call the UpdateLogstashSettings to update the configurations of a specified Logstash instance.

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

When an instance is in the activating, invalid, or frozen (inactive) state, its 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 code.

Request header

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

Request syntax

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

Request parameters

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

The ID of the 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.

Response parameters

Parameter Type Example Description
RequestId String BB1C321A-211C-4FD7-BD8B-7F2FABE2****

The ID of the request.

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


Sample requests

PATCH /openapi/logstashes/ls-cn-oew1qbgl ****/instance-settings HTTP/1.1 
common request header

Sample success responses

JSON Syntax

    "Result": {
        "instanceId": "ls-cn-oew1qbgl****",
        "version": "6.7.0_with_X-Pack",
        "description": "test",
        "nodeAmount": 1,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 20,
            "diskType": "cloud_ssd"
        "networkConfig": {
            "vpcId": "vpc-bp16k1dvzxtmagcva****",
            "vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
            "vsArea": "cn-hangzhou-i",
            "type": "vpc"
        "createdAt": "2020-07-08T03:15:27.218Z",
        "updatedAt": "2020-07-08T03:26:01.931Z",
        "commodityCode": "elasticsearch_logstash_post",
        "extendConfigs": [],
        "endTime": 4749897600000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfm2h5vbzd****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
                "zoneId": "cn-hangzhou-i",
                "status": "NORMAL"
        "instanceType": "logstash",
        "inited": true,
        "tags": [],
        "config": {},
        "endpointList": [
                "host": "172.16.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-i"
    "RequestId": "629D3748-5DB5-495F-BCAA-6EA240DA****"

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.