文档首页> 云手机服务器 CPH> API参考> 云手机服务器API> 自定义镜像管理> 查询镜像列表
更新时间：2024-04-18 GMT+08:00
查看PDF
分享

查询镜像列表

功能介绍

查询镜像列表

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

image_type

否

String

镜像类型。

  • public：公共镜像

  • private：私有镜像

  • share：共享镜像

status

否

String

镜像状态。

  • 0：CREATING 创建中

  • 1：PRODUCTION 生产态，可使用

  • 2：CREATE_FAILED 创建失败

offset

否

Integer

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

limit

否

Integer

每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。

image_id

否

String

镜像id

image_name

否

String

镜像名称

create_since

否

String

起始时间

create_until

否

String

截止时间

src_project_id

否

String

共享镜像账号的projectId

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

image_infos

Array of ListImagesView objects

镜像详情

total

Integer

总条数

request_id

String

请求的唯一标识ID。
表5 ListImagesView

参数

参数类型

描述

domain_id

String

镜像所属租户

image_name

String

镜像名称

update_time

String

镜像更新时间

create_time

String

镜像创建时间

image_size

String

镜像大小

project_id

String

project_id（当image_type为private时，才会返回此字段)

image_id

String

镜像ID

image_version

String

镜像AOSP版本

image_type

String

镜像类型 公共镜像：public 私有镜像：private 共享镜像：share

status

String

镜像状态。

  • 0：CREATING 创建中

  • 1：PRODUCTION 生产态，可使用

  • 2：CREATE_FAILED 创建失败

src_project_id

String

共享镜像账号的projectId（当image_type为share时，才会返回此字段)

请求示例

查询镜像列表

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

响应示例

状态码： 200

OK

{
  "image_infos" : [ {
    "domain_id" : "4a2a9967e4514c388a4c945efcbab9d6",
    "image_name" : "cph-private-image",
    "update_time" : "2024-04-11T06:38:21Z",
    "create_time" : "2024-04-11T06:38:21Z",
    "image_size" : 1306150912,
    "project_id" : "3a63a229aa6e47bab2153b44a7f3f50d",
    "image_id" : "23030320230421e300221a2000004433",
    "image_version" : "AOSP 9.0",
    "image_type" : "private",
    "status" : 1
  } ],
  "total" : 1,
  "request_id" : "bff458ad55f24751b0b226119ab4f9fd"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 自定义镜像管理
分享：

    相关文档

    相关产品