更新时间:2024-04-19 GMT+08:00

重启云手机

功能介绍

批量重启云手机,也可用于开启云手机。该接口为异步接口。

URI

POST /v1/{project_id}/cloud-phone/phones/batch-restart

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

image_id

String

云手机镜像。

phones

Array of PhoneProperty objects

云手机列表。

表4 PhoneProperty

参数

是否必选

参数类型

描述

phone_id

String

云手机id。

property

String

云手机属性列表,为Json格式字符串。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

jobs

Array of PhoneJob objects

任务信息。

表6 PhoneJob

参数

参数类型

描述

phone_id

String

云手机的唯一标识ID,云手机相关任务包含此字段。

job_id

String

任务的唯一标识。

error_code

String

错误码。

error_msg

String

错误说明。

请求示例

重启云手机,选择更换镜像和属性

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-restart

{
  "phones" : [ {
    "phone_id" : "a7f3a1c5258347d6b6f1def79e11f2bc",
    "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}"
  }, {
    "phone_id" : "1678567b8bab40f93711234cb80d0764",
    "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}"
  } ],
  "image_id" : "1564567b8bab40f34711234cb80d8574"
}

响应示例

状态码: 200

OK

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  }, {
    "phone_id" : "1678567b8bab40f93711234cb80d0764",
    "error_code" : "CPS.0004",
    "error_msg" : "Parameter: phone_id is invalid."
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码