【旧版】镜像列表 ListContainerImages--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】镜像列表 ListContainerImages

最近更新时间：2024.07.04 20:09:31首次发布时间：2023.06.14 12:45:16

查询业务下可以使用的自定义镜像列表信息。

需联系火山引擎技术支持开通本接口的权限。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	ListContainerImages
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
image_id_list	Query	string	否	镜像 ID 列表	以","符号隔离，示例：img-158xxxxxx,img-76xxxxxx
image_name	Query	string	否	镜像名称	如：image-1459450162840608768
image_status	Query	string	否	筛选条件，镜像状态	可同时查询多个状态（分隔符 ","）： UNKNOWN（未知） IN_QUEUE（队列中） BUILDING（构建中） BUILT（构建完成） FAILED（构建失败）
offset	Query	int64	否	分页偏移量	例：0
count	Query	int64	否	单页数量	例：10

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	int32	查询结果总量
row	`List<ContainerImage>`	查询到的镜像信息列表，详细信息，参考 ContainerImage 定义

示例

请求示例

GET https://open.volcengineapi.com?Action=ListContainerImages
&Version=2022-08-01
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListContainerImages",
        "Region": "cn-north-1",
        "RequestId": "2023110110381401DFFF1BA0CE3AE6DA3A",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "image_id": "img-158xxxxxx",
                "image_name": "test_image",
                "status_code": 11,
                "status": "BUILT",
                "image_annotation": "测试镜像",
                "image_tag": "Android-11-userdebug-xx.xx.1210",
                "image_addr": "cr-aic-cn-beijing.cr.volces.com/aosp-image-build-wyq/2100xxxxxx",
                "version": "11",
                "digest": "sha256:c7fxxxxxx",
                "size": 687703621,
                "push_at": 1698806060,
                "create_at": 1698805514,
                "update_at": 1698806070
            },
            {
                "image_id": "img-76xxxxxx",
                "image_name": "JavaSDK",
                "status_code": 11,
                "status": "BUILT",
                "image_annotation": "SDK测试",
                "image_tag": "Android-11-userdebug-xx.xx.1210",
                "image_addr": "cr-aic-cn-beijing.cr.volces.com/aosp-image-build-wyq/2100xxxxxx",
                "version": "10",
                "digest": "sha256:c7fxxxxxx",
                "size": 738329430,
                "push_at": 1698390245,
                "create_at": 1698389793,
                "update_at": 1698390272
            }
        ],
        "total": 2
    }
}