UpdateLogstashDescription - Elasticsearch - Alibaba Cloud Documentation Center

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

The instance name cannot be modified when the instance is in the activating, invalid, or inactive state.

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

PATCH|POST /openapi/logstashes/[InstanceId]/description HTTPS|HTTP

Request parameters


Parameter	Type	Required	Example	Description
InstanceId	String	Yes	ls-cn-n6w1o5jq****	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.

RequestBody

Enter the description field in the RequestBody parameter to specify the modified instance name. Example:

{
    "description": "logstash_name"
}

Response parameters


Parameter	Type	Example	Description
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	The ID of the request.
Result	Struct		The return results.
description	String	logstash_name	The name of the instance.

The Result also contains the following parameters.


Parameter	Type	Example	Description
instanceId	String	ls-cn-n6w1o5jq****	The ID of the instance.
description	String	ls-cn-abc	The name of the instance.
nodeAmount	Integer	2	The number of data nodes.
paymentType	String	postpaid	The billing method of the instance. Supported: prepaid (subscription) and postpaid (pay-as-you-go).
status	String	active	The status of the instance. Four instance statuses are supported: normal (active), effective (activating), frozen (inactive), and invalid (invalid).
esVersion	String	6.7.0_with_X-Pack	The version of the instance.
createdAt	String	2018-07-13T03:58:07.253Z	The time when the instance was created.
updatedAt	String	2018-07-13T03:58:07.253Z	The time when the instance was last updated.
nodeSpec			The configuration of the node.
└spec	String	logstash.n4.small	The specification of the node.
└disk	Integer	40	The hard disk size of the node.
networkConfig			The network configuration.
└type	String	vpc	The type of the network. Currently, only Virtual Private Cloud (VPC) is supported.
└vpcId	String	vpc-abc	The ID of the VPC.
└vswitchId	String	vsw-abc	The ID of the vSwitch.
vsArea	String	cn-hangzhou-*	The zone where the cluster resides.
domainList			The domain names returned.
└domain	String	ls-cn-abc.logstash.aliyuncs.com	The private network endpoint of the instance.
└port	Integer	7001	The port number that is used to connect to the database.

Note └ indicates a sub-parameter. For more information about other parameters, see ListLogstash .

Examples

Sample requests

PATCH /openapi/logstashes/ls-cn-n6w1o5jq****/description HTTP/1.1
common request header
{
    "description": "logstash_name"
}

Sample success responses

JSON Syntax

{
    "Result": {
        "instanceId": "ls-cn-n6w1o5jq****",
        "version": "6.7.0_with_X-Pack",
        "description": "logstash_name",
        "nodeAmount": 1,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 50,
            "diskType": "cloud_ssd"
        },
        "networkConfig": {
            "vpcId": "vpc-bp16k1dvzxtmagcva****",
            "vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
            "vsArea": "cn-hangzhou-i",
            "type": "vpc"
        },
        "createdAt": "2020-05-27T01:30:15.947Z",
        "updatedAt": "2020-07-08T02:38:47.137Z",
        "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": {
            "xpack.monitoring.elasticsearch.username": "elastic",
            "xpack.monitoring.enabled": "true",
            "slowlog.threshold.debug": "500ms",
            "xpack.monitoring.elasticsearch.password": "Elasti****",
            "xpack.monitoring.elasticsearch.hosts": "[\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\"]",
            "slowlog.threshold.warn": "2s",
            "slowlog.threshold.info": "1s",
            "slowlog.threshold.trace": "100ms"
        },
        "endpointList": [
            {
                "host": "172.16.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-i"
            }
        ]
    },
    "RequestId": "C3845099-3D0E-4D2B-9D62-F16019EE****"
}

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.