查询云手机列表-凯发k8国际娱乐官网入口
功能介绍
分页查询云手机,云手机列表按照创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在云手机,则返回空列表。
调试
您可以在中调试该接口,支持自动认证鉴权。api explorer可以自动生成sdk代码示例,并提供sdk代码示例调试功能。
uri
get /v1/{project_id}/cloud-phone/phones
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
string |
项目id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
integer |
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源数,默认值为0。 |
limit |
否 |
integer |
每页返回的资源个数。取值范围:1~200(默认值为200),一般设置为10、20、50。 |
phone_name |
否 |
string |
云手机名称,支持模糊查询。 |
server_id |
否 |
string |
云手机服务器的唯一标识。 |
status |
否 |
integer |
云手机状态。
|
type |
否 |
integer |
云手机类型。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-auth-token |
是 |
string |
用户token。 通过调用iam服务获取用户token接口获取(响应消息头中x-subject-token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
phones |
array of phone objects |
云手机信息。 |
request_id |
string |
请求的唯一标识id。 |
count |
integer |
实例总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
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服务。
|
status |
integer |
云手机状态。
|
type |
integer |
云手机类型。
|
imei |
string |
imei码。 |
traffic_type |
string |
手机路由类型。
|
volume_mode |
integer |
手机物理磁盘是否独立。
|
availability_zone |
string |
云手机服务器所在的可用区。 |
metadata |
metadata object |
订单以及产品相关信息。 |
create_time |
string |
创建时间, 时间格式为utc。 |
update_time |
string |
更新时间, 时间格式为utc。 |
参数 |
参数类型 |
描述 |
---|---|---|
order_id |
string |
订单id,不超过64个字节。 |
product_id |
string |
产品id,不超过64个字节。 |
请求示例
查询手机列表
get https://{cph endpoint}/v1/{project_id}/cloud-phone/phones
响应示例
状态码: 200
ok
{ "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" : "cn-southwest-242b", "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" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
ok |
错误码
请参见。
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨