RestartInstance

Unduh

Mode fokus

Ukuran font

Terakhir diperbarui: 2026-10-13 13:26:43

1. API Description

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

Restart ES cluster instances for system version update.

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: RestartInstance.
Version	Yes	String	Common Params. The value used for this API: 2018-04-16.
Region	Yes	String	Common Params. 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: force restart false: do not force restart Default value: false
RestartMode	No	Integer	Restart mode: 0 rolling restart; 1 full restart
UpgradeKernel	No	Boolean	Select whether to upgrade the kernel patch version upon restart

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Restarting ES Cluster Instance

For version update.

Input Example

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.ErrorClusterState	Cluster status error.
InternalError	Internal error.
InvalidParameter.InvalidAppId	The APPID value does not match the expectation.
InvalidParameter.InvalidEsVersion	The instance version EsVersion does not match the expectation.
InvalidParameter.InvalidInstanceId	Invalid InstanceId. No corresponding resources were found.
InvalidParameterValue.ConfigInfo	Component configuration value error.
ResourceNotFound.ClusterInfoNotFound	Failed to obtain the cluster resource.
ResourceNotFound.DBInfoNotFound	Failed to obtain the database resource.
UnsupportedOperation.ClusterStateNoReplication	Some indexes in the cluster have no backup.
UnsupportedOperation.ClusterStateUnHealth	Cluster status is abnormal (not green).
UnsupportedOperation.CvmStatusStopped	cvm instances that are shut down
UnsupportedOperation.DiskFreeSpaceInsufficient	Insufficient free space on the node disk
UnsupportedOperation.HeteroScalingExecuting	An incomplete heterogeneous scaling process exists.
UnsupportedOperation.InstanceTypeError	This operation is not supported. The service type is incorrect.
UnsupportedOperation.StatusNotNormal	This operation is not supported. The instance is not running as normal.
UnsupportedOperation.StatusNotSupport	This operation is not supported. The instance status is incorrect.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Elasticsearch Service