调用 RestartInstance 接口,重启实例中的所有节点。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RestartInstance | 要执行的操作,取值:RestartInstance。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
InstanceId | String | 是 |
| 需要重启的实例 ID。 |
Force | Boolean | 否 |
| 标识是否是一次强制重启,默认为false,取值说明如下: |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TaskId | String |
| 返回的任务 ID。 |
InstanceId | String |
| 重启实例的 ID。 |
POST https://open.volcengineapi.com/?Action=RestartInstance&Version=2023-01-01 Content-Type: application/json X-Date: 20231003T104027Z Authorization: HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b**** { "InstanceId": "o-00k***o718", "Force": false }
{ "ResponseMetadata": { "Action": "RestartInstance", "Version": "2023-01-01", "RequestId": "2023060411042001001002322***", "Service": "ESCloud", "Region": "cn-beijing" }, "Result": { "InstanceId": "o-00k***o718", "TaskId": "edc9bbcf802*****9a3abac9edde" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | IllegalParameter | 非法参数。可能是参数缺失,也可能是参数不符合接口要求 |
200 | InternalServerError | 服务由于异常退出,无法完成接口请求操作 |
200 | Unauthorized | 用户无权限调用接口 |