RebootInstance
Description
when an ECS instance is in a running (Running) state, the calling RebootInstance can restart the instance.
Request Method
POST
Request Path
/apsara/route/Ecs/RebootInstance
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| InstanceId | BODY | string | Yes | i-bp67acfmxazb4ph*** | specifies the ID of the instance. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| ForceStop | BODY | boolean | No | false | Whether to force shutdown before restarting the ECS instance. Value range: true: forced shutdown. Equivalent to a typical power-off operation, all cache data that is not written to the storage device will be lost. false (default): normal shutdown. |
| DryRun | BODY | boolean | No | false | whether to precheck only this request. Value range: true: send a check request without restarting the instance. Check items include required parameters, request format, business restrictions, and ECS inventory. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned. false (default): sends a normal request and directly restarts the instance after checking. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}