文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 手机实例管理/ 关闭云手机
更新时间：2024-11-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

关闭云手机

功能介绍

批量关闭云手机。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

phone_ids

是

Array of strings

云手机id列表。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

jobs

Array of PhoneJob objects

任务信息。
表5 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-stop

{
  "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}

响应示例

状态码： 200

OK

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  }, {
    "phone_id" : "1678567b8bab40f93711234cb80d0764",
    "job_id" : "1564567b8bab40f34711234cb80d5678"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 手机实例管理

相关文档