Tencent Cloud

search by keyword

Recent Pages

Documentation

RestartInstance

Last updated: 2020-03-06 11:10:56

1. API Description

Domain name for API request: es.tencentcloudapi.com.

This API is used to restart an ES cluster instance (for operations such as system update).

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: es.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: RestartInstance.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
ForceRestart	No	Boolean	Whether to force restart true: Yes false: No Default value: false

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Restarting an ES cluster instance

This example shows you how to perform operations such as version update.

Input Example

https://es.tencentcloudapi.com/?Action=RestartInstance
&InstanceId=es-xxxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "7f0e35a7-e03b-42cd-aa4f-0c1471xxxxxx"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.