查询云手机列表 - ListCloudPhones

功能介绍

分页查询云手机，云手机列表按照创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在云手机，则返回空列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/cloud-phone/phones

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。
limit	否	Integer	每页返回的资源个数。取值范围：1~200（默认值为100），一般设置为10、20、50。
phone_name	否	String	云手机名称，支持模糊查询。
server_id	否	String	云手机服务器的唯一标识。
status	否	Integer	云手机状态。 1：创建中 2：运行中 3：重置中 4：重启中 6：冻结 7：正在关机 8：已关机 -5：重置失败 -6：重启失败 -7：手机异常 -8：创建失败 -9：关机失败
type	否	Integer	云手机类型。 0：普通云手机

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
phones	Array of Phone objects	云手机信息。
request_id	String	请求的唯一标识ID。
count	Integer	实例总数。

表5 Phone
参数	参数类型	描述
phone_name	String	云手机的名称，不超过65个字符。
server_id	String	云手机所在的服务器ID，不超过32个字节。
phone_id	String	云手机的唯一标识，不超过32个字节。
phone_model_name	String	云手机规格名称，不超过64个字节。
image_id	String	云手机镜像ID，不超过32个字节。
image_version	String	镜像版本。
vnc_enable	String	云手机是否开启VNC服务。 true：开启 false：不开启
status	Integer	云手机状态。 1：创建中 2：运行中 3：重置中 4：重启中 6：冻结 7：正在关机 8：已关机 -5：重置失败 -6：重启失败 -7：手机异常 -8：创建失败 -9：关机失败
type	Integer	云手机类型。 0：普通云手机 1：试玩云手机
imei	String	imei码。
traffic_type	String	手机路由类型。 direct：默认路由 routing：路由到编码容器
volume_mode	Integer	手机物理磁盘是否独立。 0：不独立 1：独立
availability_zone	String	云手机服务器所在的可用区。如上海一可用区1为cn-east-3a。
metadata	metadata object	订单以及产品相关信息。
has_encrypt	Boolean	当前手机是否开启文件级加密
create_time	String	创建时间，时间格式为UTC。
update_time	String	更新时间，时间格式为UTC。

表6 metadata
参数	参数类型	描述
order_id	String	订单ID，不超过64个字节。
product_id	String	产品ID，不超过64个字节。

请求示例

查询手机列表

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones

响应示例

状态码：200

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "count" : 1,
  "phones" : [ {
    "phone_name" : "mobile-0001",
    "server_id" : "88b8449b896f3a4f0ad57222dd91909",
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "phone_model_name" : "AOSP-1U4G15G-001",
    "image_version" : "AOSP 7.0",
    "image_id" : "88b8449b896f3a4f0ad57222dd91909",
    "vnc_enable" : "true",
    "status" : 2,
    "type" : 0,
    "imei" : "869287243397729",
    "availability_zone" : "xxxxxx",
    "traffic_type" : "direct",
    "volume_mode" : 0,
    "metadata" : {
      "order_id" : "CS1710111105S8IPB",
      "product_id" : "00301-25217-0--0"
    },
    "create_time" : "2017-10-10T00:00:00Z",
    "update_time" : "2018-10-10T00:00:00Z"
  } ]
}