Call the RestartLogstash to restart a specified instance. After the instance is restarted, it enters the activating 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

POST /openapi/logstashes/[InstanceId]/actions/restart HTTPS|HTTP

Request parameters

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

The ID of the instance.
force Boolean No true

Specifies whether to forcibly restart the instance. true indicates enforcing, and false indicates not enforcing.

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 F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.

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

Examples

Sample requests

POST /openapi/logstashes/ls-cn-v0h1kzca****/actions/restart HTTP/1.1 
common request header

Sample success responses

JSON Syntax 

{
    "Result": {
        "instanceId": "ls-cn-v0h1kzca****",
        "version": "7.4.0_with_X-Pack",
        "description": "es-74-keepit",
        "nodeAmount": 1,
        "paymentType": "prepaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 20,
            "diskType": "cloud_ssd"
        },
        "networkConfig": {
            "vpcId": "vpc-bp12nu14urf0upaf4****",
            "vswitchId": "vsw-bp131d5ag0vjd5ja3****",
            "vsArea": "cn-hangzhou-h",
            "type": "vpc"
        },
        "createdAt": "2020-03-26T09:23:06.575Z",
        "updatedAt": "2020-05-12T11:06:14.132Z",
        "commodityCode": "elasticsearch_logstash_pre",
        "extendConfigs": [],
        "endTime": 1619884800000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfm2h5vbzd****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
            {
                "zoneId": "cn-hangzhou-h",
                "status": "NORMAL"
            }
        ],
        "instanceType": "logstash",
        "inited": true,
        "tags": [],
        "config": {
            "slowlog.threshold.warn": "2s",
            "slowlog.threshold.info": "1s",
            "slowlog.threshold.debug": "500ms",
            "slowlog.threshold.trace": "100ms"
        },
        "endpointList": [
            {
                "host": "10.7.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-h"
            }
        ]
    },
    "RequestId": "831AD23B-175F-47F1-8314-AFBB9947****"
}

Error codes

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