查询手机镜像 - ListCloudPhoneImages

功能介绍

根据项目ID查询可用的手机镜像。

调试

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

授权信息

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

URI

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

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

表2 Query参数
参数	是否必选	参数类型	描述
image_type	否	String	镜像类型公共镜像：public 私有镜像：private 共享镜像：share 所有类型镜像：all
marker	否	String	分页标记。
limit	否	Integer	每页返回的镜像个数。取值范围：1~500（默认值为500），一般设置为10、20、50。当image_type传all时，分页返回顺序按公共镜像：public 私有镜像，private 共享镜像：share

请求参数

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

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
request_id	String	请求的唯一标识ID。
phone_images	Array of PhoneImage objects	手机镜像信息。
page_info	page_info object	页标记。

表5 PhoneImage
参数	参数类型	描述
image_name	String	手机镜像名称，不超过128个字节。
os_type	String	镜像操作系统类型，不超过16个字节。
is_public	Integer	镜像类型。 1：公有镜像 2 ：私有镜像
os_name	String	手机操作系统，不超过36个字节。
image_label	String	镜像适用的云手机规格。 cloud_phone：适用于physical.rx1.xlarge 类型云手机服务器 cloud_phone_1620：适用于physical.kg1.4xlarge.cp类型云手机服务器 cloud_game：适用于physical.rx1.xlarge.cg 类型云手游服务器 cloud_game_1620：适用于physical.kg1.4xlarge.cg 类型云手游服务器 qemu_phone：适用于physical.rx1.xlarge 类型云手机服务器中 qemu类型云手机规格
image_id	String	手机镜像唯一标识ID，不超过32个字节。
is_support_encrypt	Boolean	当前镜像是否支持文件级加密。
receive_status	Integer	共享镜像接收状态（0: 待接收，1: 已接收，2: 已拒绝）

表6 page_info
参数	参数类型	描述
next_marker	String	返回下一页查询marker。

请求示例

查询手机镜像

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

响应示例

状态码：200

{
  "phone_images" : [ {
    "image_name" : "AOSP",
    "os_type" : "aosp",
    "is_public" : 1,
    "os_name" : "AOSP7.1.1",
    "image_label" : "cloud_game",
    "image_id" : "20032420200401a60b0003a99684b8ea"
  }, {
    "image_name" : "AOSP",
    "os_type" : "aosp",
    "is_public" : 1,
    "os_name" : "AOSP7.1.1",
    "image_label" : "cloud_phone",
    "image_id" : "20032120200330a20b000eae5b8c01e6"
  }, {
    "image_name" : "AOSP",
    "os_type" : "aosp",
    "is_public" : 1,
    "os_name" : "AOSP7.0.0",
    "image_label" : "qemu_phone",
    "image_id" : "be4d231e44d2a4ccf612660a473fe1e3"
  } ],
  "page_info" : {
    "next_marker" : "string"
  },
  "request_id" : "5aac6ab146ba76e5b12a3d00a03a9869"
}