重启云机 RebootHost--云手机-火山引擎

文档中心

立即注册

导航

重启云机 RebootHost

最近更新时间：2025.05.19 15:33:53首次发布时间：2024.03.04 19:40:02

此接口用于重启指定云机。

注意事项

注意

在调用本接口前，请先确认当前业务类型是否为本地存储。“云机”是本地存储业务的资源订购单位，因此，本接口仅适用于本地存储业务。对于采用云盘存储方案的业务，本接口不适用，请勿尝试调用。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=RebootHost&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`RebootHost`	接口名称。当前 API 的名称为 `RebootHost`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数类型是否必选示例值描述

ProductId String 是 1749281594201xxxxxx 业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。

HostIdList Array of String 是 ["7337159054625xxxxxx","7337159054626xxxxxx"] 云机 ID 列表。可通过调用 ListHost 接口获取。

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。
HostIdList	Array of String	是	`["7337159054625xxxxxx","7337159054626xxxxxx"]`	云机 ID 列表。可通过调用 ListHost 接口获取。
Force	Boolean	否	`false`	是否强制重启云机。取值如下： `true`：是，忽略云机上实例的运行状态，强制重启云机，但有可能造成实例数据损坏，请谨慎操作。 `false`：（默认）否，仅当云机上所有实例均已关机时，才执行重启操作，否则接口返回失败。

Force

Boolean

否

false

是否强制重启云机。取值如下：

true：是，忽略云机上实例的运行状态，强制重启云机，但有可能造成实例数据损坏，请谨慎操作。
false：（默认）否，仅当云机上所有实例均已关机时，才执行重启操作，否则接口返回失败。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TaskId	String	`7337299555295xxxxxx`	任务 ID。
TaskAction	String	`RebootHost`	任务类型。取值为 `RebootHost`。
Jobs	Array of HostJob	`-`	子任务列表。

HostJob

参数	类型	示例值	描述
JobId	String	`job-7337613614158xxxxxx-7337159054625xxxxxx`	子任务 ID。
HostId	String	`7337159054625xxxxxx`	云机 ID。
Status	Integer	`10`	子任务状态。包含以下取值： `10`：执行中 `100`：成功 `-2`：部分失败 `-1`：全部失败
CreateAt	Long	`1700000000`	子任务创建时间。Unix 时间戳，单位为秒。
UpdateAt	Long	`1700000000`	子任务更新时间。Unix 时间戳，单位为秒。

请求示例

POST https://open.volcengineapi.com?Action=RebootHost&Version=2023-10-30
{
    "ProductId": "1749281594201xxxxxx",
    "HostIdList": [
        "7332685607262xxxxxx",
        "7332747535309xxxxxx"
    ],
    "Force": false
}

返回示例

{
    "ResponseMetadata": {
        "Action": "RebootHost",
        "Region": "cn-north-1",
        "RequestId": "2024022015395***8A2E54839785D",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": {
        "TaskId": "7337299555295xxxxxx",
        "TaskAction": "RebootHost",
        "Jobs": [
            {
                "HostId": "7332685607262xxxxxx",
                "JobId": "job-7337299555295xxxxxx-7332685607262xxxxxx",
                "Status": 10,
                "CreateAt": 1708000000,
                "UpdateAt": 1708000000
            },
            {
                "HostId": "7332747535309xxxxxx",
                "JobId": "job-7337299555295xxxxxx-7332747535309xxxxxx",
                "Status": 10,
                "CreateAt": 1708000000,
                "UpdateAt": 1708000000
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。