更新时间:2022-03-31 GMT+08:00
分享

查询云手机列表

功能介绍

  • 接口名称

    ListCloudPhones

  • 功能描述

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

URI

GET /v1/{project_id}/cloud-phone/phones?phone_name={phone_name}&server_id={server_id}&status={status}&offset={offset}&limit={limit}&type={type}

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

phone_name

String

云手机名称,支持模糊查询。

server_id

String

云手机服务器ID

status

Integer

云手机状态,分为以下几种。

  • 0、1:创建中
  • 2:运行中
  • 3:重置中
  • 4:重启中
  • 6:冻结
  • 7:正在关机
  • 8:已关机
  • -5:重置失败
  • -6:重启失败
  • -7:手机异常
  • -8:创建失败
  • -9:关机失败

offset

Integer

偏移量

偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源数,默认值为0。

limit

Integer

每页返回的资源个数

取值范围:1~100(默认值为100)

一般设置为10、20、50

type

Integer

云手机类型

  • 0 表示普通云手机
  • 1 表示试玩云手机

请求消息

  • 请求参数

  • 请求样例
    1
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones?offset=0&limit=10
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    phones

    Array of objects

    云手机信息,详情请参见表2

    表2 phone数据结构说明

    参数

    参数类型

    描述

    phone_name

    String

    云手机的名称,不超过65个字符。

    server_id

    String

    云手机所在的服务器ID,不超过32个字节。

    phone_id

    String

    云手机的唯一标识,不超过32个字节。

    phone_model_name

    String

    云手机规格名称,不超过64个字节。

    详情请参见云手机规格列表

    image_id

    String

    云手机镜像ID,不超过32个字节。

    vnc_enable

    String

    云手机是否开启VNC服务

    • true表示开启
    • false表示不开启

    metadata

    Object

    订单以及产品相关信息,详情请参见表3

    status

    Integer

    云手机状态

    • 0、1:创建中
    • 2:运行中
    • 3:重置中
    • 4:重启中
    • 6:冻结
    • 7:正在关机
    • 8:已关机
    • -5:重置失败
    • -6:重启失败
    • -7:手机异常
    • -8:创建失败
    • -9:关机失败

    type

    Integer

    云手机类型

    • 0 表示普通云手机
    • 1 表示试玩云手机

    create_time

    String

    创建时间

    时间格式为UTC。

    update_time

    String

    更新时间

    时间格式为UTC。

    表3 metadata数据结构说明

    参数

    参数类型

    描述

    order_id

    String

    订单ID,不超过64个字节。

    product_id

    String

    产品ID,不超过64个字节。

    probation_begin_time

    String

    云手机试玩开始时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    probation_end_time

    String

    云手机试玩结束时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

  • 响应样例
    { 
        "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085", 
        "phones": [
            {
                "phone_name": "mobile-0001",
                "server_id": "88b8449b896f3a4f0ad57222dd91909",
                "phone_id": "1234567b8bab40ffb711234cb80d0234",
                "phone_model_name": "AOSP-1U4G15G-001",
                "image_id": "88b8449b896f3a4f0ad57222dd91909",
                "vnc_enable": "true",
                "status": 2,
                "type": 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"
            },
            ……
        ]
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读