实例冷重启 ColdRebootInstance--云手机-火山引擎

文档中心

立即注册

导航

实例冷重启 ColdRebootInstance

最近更新时间：2024.05.09 17:19:39首次发布时间：2021.12.15 17:54:53

冷重启指定实例。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
instance_id_list	String[]	是	执行冷重启操作的实例 ID 列表，可通过调用 ListInstance 接口获取

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
job_id	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
success_id_list	String[]	冷重启成功的实例 ID 列表
fail_id_list	String[]	冷重启失败的实例 ID 列表
failed_list	Object	冷重启失败的实例 ID 及对应错误信息列表，参考以下 `List<CaseWithMsg>` 结构说明

List<CaseWithMsg> 结构说明

字段	类型	说明
id	String	实例 ID
msg	String	操作失败的错误信息

示例

请求示例

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

{
    "product_id": "14677396781xxxxxxxx",
    "instance_id_list": ["i-1724163532xxxxxx","i-1724163533xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ColdRebootInstance",
        "Region": "cn-north-1",
        "RequestId": "202308031419017EA44AD47D48911B552B",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-7299229146923xxxxxx",
        "success_id_list": [
            "i-1724163532xxxxxx",
            "i-1724163533xxxxxx"
        ],
        "fail_id_list": [],
        "failed_list": []
    }
}