【2023年10月13日】边缘计算机器部分接口鉴权升级公告
【2022年06月01日】边缘计算机器网络带宽支持按天结算公告
Domain name for API request: ecm.intl.tencentcloudapi.com.
This API is used to restart an instance. Only instances in RUNNING status can be restarted. The instance status will become REBOOTING when the API is called successfully and will become RUNNING when the instance is restarted successfully. Forced restart is supported. Just like powering off a physical PC and restarting it, a forced restart may cause data loss or file system corruption. Make sure that you use this API only when the server cannot be restarted normally.
A maximum of 20 requests can be initiated per second for this API.
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: RebootInstances. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceIdSet.N | Yes | Array of String | List of IDs of the instances to be restarted. You can request up to 100 instances in a region at a time. |
| ForceReboot | No | Boolean | Whether to force restart the instance after it failed to be restarted normally. Valid values: TRUE: yes; FALSE: no; Default value: FALSE. |
| StopType | No | String | Shutdown type. Valid values: SOFT: soft shutdown HARD: hard shutdown SOFT_FIRST: perform a soft shutdown first; if it fails, perform a hard shutdown Default value: SOFT. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to restart an instance.
https://ecm.intl.tencentcloudapi.com/?Action=RebootInstances
&InstanceIdSet.0=ein-496721al
&InstanceIdSet.1=ein-438242bp
&<Common request parameters>{
"Response": {
"RequestId": "d40cdb72-7bc0-4b48-b3aa-djl3424-a6482"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InternalOperationFailure | Internal error. |
| FailedOperation.OperationNotAllow | The current operation is not allowed. |
| InvalidParameter.InvalidDataFormat | The data format is incorrect. |
| InvalidParameterValue.InvalidDataDiskType | The data disk type is invalid. |
| InvalidParameterValue.InvalidISPInNode | The ISP is invalid. |
| InvalidParameterValue.InvalidInstanceID | The instance ID is invalid. |
| InvalidParameterValue.ParameterValueTooLarge | The parameter value exceeds the limit. |
| OperationDenied.InstanceOperationInProgress | The current operation is not allowed. |
| ResourceNotFound.InstanceNotExist | The instance is invalid. |
| ResourceUnavailable.InstanceNotRunning | The instance is not running. |
| UnauthorizedOperation.ForbiddenOperation | You don't have the permission to perform this operation. |
文档反馈