重启云手机_云手机 CPH_API参考_云手机API_手机实例管理

功能介绍

• 接口名称

  RestartCloudPhone

• 功能描述

  批量重启云手机，也可用于开启云手机。该接口为异步接口，可调用查询任务执行状态和查询任务执行状态列表查询任务执行结果。

URI

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

请求消息

• 请求参数

  参数	是否必选	参数类型	描述
  phones	是	Array of objects	待重启的云手机信息 详情请参见表2。
  image_id	否	String	待更新的镜像ID

  表2 phones数据结构说明

  参数	是否必选	参数类型	描述
  phone_id	是	String数组	云手机ID
  property	否	jsonString	云手机属性列表，详情请参见云手机属性列表。

• 请求样例

  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"
  }

响应消息

• 响应参数

  参数	参数类型	描述
  request_id	String	请求的唯一标识ID
  jobs	Array of objects	任务信息，详情请参见表3。

  表3 job数据结构说明

  参数	参数类型	描述
  phone_id	String	云手机的唯一标识，云手机相关任务包含此字段。
  job_id	String	任务的唯一标识
  error_code	String	错误码，详情请参见错误码。
  error_msg	String	错误说明

• 响应样例

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

返回值

请参考返回值。

错误码

请参考错误码。