查询云手机服务器列表

功能介绍

● 接口名称

ListCloudPhoneServers

● 功能描述

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

URI

GET /v1/{project_id}/cloud-phone/servers?

offset={offset}&limit={limit}&server_name={server_name}&network_version={netw ork_version}

参数说明请参见表5-1。

表5-1 参数说明

参数 是否必选 参数类型 描述

project_id 是 String 项目ID

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

offset 否 Integer 偏移量

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

参数 是否必选 参数类型 描述

limit 否 Integer 每页返回的资源个数

取值范围：1~100（默认值为100）

一般设置为10、20、50 server_nam

e 否 String 云手机服务器名称，支持模糊查询。

server_id 否 String 云手机服务器的唯一标识 network_ve

rsion 否 String 云手机服务器是否为自定义网络标

识。

取值范围：

● "v1"，系统定义网络的云手机服 务器。

● "v2"，自定义网络的云手机服务 器。

请求消息

● 请求参数 无

● 请求样例

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers?offset=0&limit=10

响应消息

● 响应参数

参数 参数类型 描述

request_id String 请求的唯一标识ID

servers Array of objects 云手机服务器信息，详情请参见 表5-2。

表5-2 server 数据结构说明

参数 参数类型 描述

server_name String 云手机服务器名称

不超过65字符，只支持英文字 母、数字、汉字、下划线和中划 线。

availability_zone String 云手机服务器所在的可用区

参数 参数类型 描述

server_id String 云手机服务器的唯一标识，不超

过32个字节。

server_model_name String 云手机服务器规格名称，不超过 64个字节。

详情请参见服务器规格列表。

phone_model_name String 云手机规格名称，不超过64个字 节。

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

keypair_name String 连接云手机所使用的密钥对的名 称，不超过64个字节。

status Integer 服务器状态

● 0、1、3、4：创建中

● 2：异常

● 5：正常

● 8：冻结

● 10：关机

vpc_id String 云手机服务器所属虚拟私有云

（简称VPC）的ID resource_project_id String 云手机服务器的项目ID

cidr String 云手机服务器所属虚拟私有云

（简称VPC）的网段

metadata Object 订单以及产品相关信息，详情请

参见表5-3。

addresses Array of objects 云手机服务器的IP相关信息，详 情请参见表5-4。

network_version String 是否为自定义网络的云手机服务 器标识。

● "v1"，非自定义网络的云手 机服务器。

● "v2"，自定义网络的云手机 服务器。

create_time String 创建时间

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

参数 参数类型 描述 update_time String 更新时间

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

表5-3 metadata 数据结构说明

参数 参数类型 描述

order_id String 订单ID，不超过64个字节。

product_id String 产品ID，不超过64个字节。

probation_begin_tim

e String 云手机试玩开始时间

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

probation_end_time String 云手机试玩结束时间

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

表5-4 address 数据结构说明

参数 参数类型 描述

intranet_ip（过期） String 云手机服务器的内网IP access_ip（过期） String 云手机服务器的公网IP server_ip（新增） String 云手机服务器的内网IP public_ip（新增） String 云手机服务器的公网IP

● 响应样例

{ "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085", "servers": [

{

"server_name": "server-1", "availability_zone": "br-iaas-1",

"server_id" : "88b8449b896f3a4f0ad57222dd91909", "server_model_name": "physical.rx1.xlarge", "phone_model_name": "aphs1.medium.4.aosp", "keypair_name": "",

"status": 5,

"vpc_id": "6e3feb2c-b9c9-4ac5-abf1-96d60e3dfea2",

"resource_project_id": "2347275010d3440d963d3fcb8931ff55", "cidr": "172.31.0.0/16",

"access_ip": "122.237.0.111",

"server_id" : "88b8449b896f3a4f0ad57222dd91909", "server_model_name": "physical.rx1.xlarge", "phone_model_name": "aphs1.large.2.aosp", "keypair_name": "",

"status": 2,

"vpc_id": "6e3feb2c-b9c9-4ac5-abf1-96d60e3dfea2",

"resource_project_id": "2347275010d3440d963d3fcb8931ff55", "cidr": "172.31.0.0/16",