文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 手机实例管理/ 获取云手机连接信息
更新时间：2024-08-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取云手机连接信息

功能介绍

获取云手机连接信息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

phone_ids

是

Array of strings

phone_id数组，单次请求最大限制10

client_type

是

String

申请接入的客户端类型

  • ANDROID: 安卓平台SDK

  • WINDOWS: Windows平台SDK

  • H5_MOBILE: H5移动端SDK

  • H5_PC: H5 PC端SDK

  • IOS: iOS平台SDK

枚举值：

  • ANDROID

  • WINDOWS

  • H5_MOBILE

  • H5_PC

  • IOS

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

connect_infos

Array of ConnectInfo objects

云手机接入信息列表

errors

Array of ConnectErrorInfo objects

错误信息
表5 ConnectInfo

参数

参数类型

描述

phone_id

String

云手机的唯一标识。

access_info

access_info object

云手机接入信息
表6 access_info

参数

参数类型

描述

access_ip

String

云手机实例的公网访问IP

intranet_ip

String

云手机实例的内网访问IP

access_ipv6

String

云手机服务器IPv6 IP

access_port

Integer

云手机实例的访问端口

session_id

String

本次接入的会话ID

timestamp

String

时间戳

ticket

String

签名令牌
表7 ConnectErrorInfo

参数

参数类型

描述

phone_id

String

云手机的唯一标识ID。

error_code

String

错误码。

error_msg

String

错误说明。

请求示例

获取云手机连接信息

POST https://{CPHEndpoint}/v1/{project_id}/cloud-phone/phones/batch-connection

{
  "client_type" : "ANDROID",
  "phone_ids" : [ "1564567b8bab40f34711234cb80d8574", "1234567b8bab40ffb711234cb80d0234", "1234567b8bab40ffb711234cb8654321" ]
}

响应示例

状态码： 200

OK

{
  "request_id" : "70bb40bef50e4a14b116a5a527fd7432",
  "connect_infos" : [ {
    "phone_id" : "1564567b8bab40f34711234cb80d8574",
    "access_info" : {
      "access_ip" : "213.32.43.22",
      "intranet_ip" : "192.168.0.25",
      "access_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "access_port" : 14308,
      "session_id" : "9864567a7bab40f34711234cb8087474",
      "timestamp" : "122478329742",
      "ticket" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  } ],
  "errors" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "error_code" : "CPS.0018",
    "error_msg" : "Access info not found."
  }, {
    "phone_id" : "1234567b8bab40ffb711234cb8654321",
    "error_code" : "CPS.0005",
    "error_msg" : "Phone not found."
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 手机实例管理

相关文档