文档首页> > API参考> API> 生命周期管理> 查询云手机列表

查询云手机列表

分享
更新时间: 2019/06/14 15:04

功能介绍

  • 接口名称

    ListCloudPhones

  • 功能描述

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

URI

  • URI格式

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

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

    phone_name

    String

    按云手机名称模糊查询。

    server_id

    String

    按云手机服务器ID查询。

    status

    int

    按云手机状态查询。

    手机状态分为以下几种。

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

    offset

    int

    偏移量

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

    limit

    int

    • 取值范围:0~100

      取值一般为10,20,50

    • 功能说明:每页返回的资源个数。

    默认值为100。

    type

    int

    云手机类型

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

请求

请求样例

GET https://{CPH_Endpoint}/v1/{project_id}/cloud-phone/phones?offset=0&limit=100

响应

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    phones

    Phone结构体数组

    请参见表1

    表1 phone结构体

    名称

    参数类型

    说明

    phone_name

    String

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

    server_id

    String

    云手机所在的服务器ID,不得超过32byte。

    phone_id

    String

    云手机的唯一标识,不得超过32byte。

    phone_model_name

    String

    手机规格名称,不得超过64byte。

    名称的释义请参见手机规格列表

    image_id

    String

    云手机镜像ID,不得超过32byte。

    vnc_enable

    String

    云手机是否开启vnc服务

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

    metadata

    metadata结构体

    订单与产品信息,有关结构体的详细内容请参考表2

    status

    int

    手机状态

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

    type

    int

    云手机类型

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

    create_time

    String

    创建时间。

    时间格式为UTC时间。

    update_time

    String

    更新时间。

    时间格式为UTC时间。

    表2 metadata结构体

    名称

    参数类型

    说明

    order_id

    String

    订单ID,不得超过64byte。

    product_id

    String

    产品ID,不得超过64byte。

    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"
            },
            ……
         ] 
    }

返回值

请参考返回值

如果您喜欢这篇文档,您还可以:

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区