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

文档中心

立即注册

导航

重启云机 RebootHost

最近更新时间：2024.05.09 10:30:31首次发布时间：2023.08.03 11:53:20

对指定云机执行重启操作。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	RebootHost
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
ProductId	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
HostIdList	Array of String	是	需要重启的云机 ID 列表，可通过调用 ListHost 接口获取
Force	Boolean	否	重启云机前是否强制关机，可选值： false：正常关机，默认 true：强制关机

字段

类型

必填

说明

ProductId

String

是

业务 ID，可在「云手机控制台-业务管理-业务详情」中获取

HostIdList

Array of String

是

需要重启的云机 ID 列表，可通过调用 ListHost 接口获取

Force

Boolean

否

重启云机前是否强制关机，可选值：

false：正常关机，默认
true：强制关机

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
JobId	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
SuccessIdList	Array of String	重启成功的云机 ID 列表
FailIdList	Array of String	重启失败的云机 ID 列表

示例

请求示例

POST https://open.volcengineapi.com?Action=RebootHost
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "ProductId": "14677396781xxxxxxxx",
    "HostIdList": ["h-1770036287xxxxxx","h-1771292679xxxxxx"],
    "Force": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "RebootHost",
        "Region": "cn-north-1",
        "RequestId": "2021122810471701021216810313006DA3",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "JobId": "req-7299283527638xxxxxx",
        "SuccessIDList": [
            "h-1770036287xxxxxx",
            "h-1771292679xxxxxx"
        ],
        "FailIDList": []
    }
}