You need to enable JavaScript to run this app.
云手机

云手机

复制全文
【旧版】镜像管理
【旧版】查询镜像信息 ListImage
复制全文
【旧版】查询镜像信息 ListImage

查询指定公共镜像或自定义镜像相关信息。

使用说明

该接口为历史版本,推荐您使用新版接口查询 AOSP 镜像列表 ListAOSPImage

请求说明

  • 请求方式:GET
  • 请求地址:https://open.volcengineapi.com?Action=ListImage&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数

类型

是否必选

示例值

描述

Action

String

ListImage

接口名称。当前 API 的名称为 ListImage

Version

String

2023-10-30

接口版本。当前 API 的版本为 2023-10-30

AccountId

String

21000xxxx

火山引擎账号 ID。

ImageId

String

img-xxxxx1

镜像 ID。可以指定单个需要查询的镜像。

ImageIdList

String

img-xxxxx2,img-xxxxx3

镜像 ID 列表,可以指定多个需要查询的镜像,以英文逗号","分割。

ImageName

String

image-1459450162840xxxxxx

镜像名称。

AospVersion

String

10

镜像版本,包含以下取值:

  • 10:AOSP 10;
  • 11:AOSP 11;
  • 12:AOSP 12;
  • 13:AOSP 13。

IsPublic

Boolean

false

是否查找公共镜像,包含以下取值:

  • true:查找公共镜像;
  • false:(默认值)用户自定义镜像。

ImageStatus

Integer

11

镜像状态,包含以下取值:

  • 1:导入中,待构建;
  • 2:构建中;
  • 11:构建完成;
  • -1:构建失败。

Offset

Long

0

查询结果的起始位置,用于指定从哪一条记录开始返回数据。例如,若 Offset 为 10,则表示从第 11 条记录开始。默认值为 0。

说明

可与 Count 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。

Count

Long

10

单次查询返回的最大记录数,用于控制每次查询返回的数据量。例如,若 Count 为 100,则表示在查询数据时,系统将每次返回 100 条记录。

说明

可与 Offset 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。

ExpandScope

Boolean

false

是否查询未发布的公共镜像,包含以下取值:

  • true:是,此时需要提供准确的 ImageId;
  • false:(默认值)否,只查询已发布的公共镜像。

ProductId

String

1591495366954xxxxxx

业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数

类型

示例值

描述

Row

Array of Image

-

镜像信息列表,参看 Image 数据结构。

Total

Long

1

查询结果总数。

Image

参数

类型

示例值

描述

ImageId

String

img-15xxxxxx

镜像 ID。

CreateAt

Long

1722978531

构建任务创建时间戳。

UpdateAt

Long

1722978531

构建任务更新时间戳。

ImageName

String

img-15xxxxxx-AOSP10-2100xxxxxx-自定义镜像

镜像名称。

ImageSize

Long

808861901

镜像大小,单位 byte。

AospVersion

String

10

镜像版本。

ImageRemark

String

test

镜像描述。

ImageStatus

Integer

11

镜像状态。

PreheatStatus

Integer

0

镜像预热状态,包含以下取值:

  • 0:非预热镜像;
  • 1:预热中;
  • 2:预热成功;
  • 3:预热失败;
  • 4:等待预热中。

ImageStatusStr

String

BUILT

镜像状态描述。

AospVersionName

String

AOSP10

镜像版本名称。

ImageDownloadUrl

String

huanan-xxxxxx.tos-cn-xxxx.volces.com-xxxxxxxxxxxx

镜像下载地址。
如需获取自定义镜像文件下载地址,请先联系技术支持团队获取权限,获取到权限后需重新构建镜像,方可返回该字段。

ImageResourceType

String

ARM_SoC

镜像对应的适配架构类型。包含以下取值:

  • ARM_SoC:ARM 板卡可用;
  • ARM_Server:ARMServer 资源可用;
  • General:通用类型,可适配多个类型的资源。

UploadImageStatus

Integer

0

镜像上传状态。
如需获取自定义镜像上传状态,请先联系技术支持团队获取权限,获取到权限后需重新构建镜像,方可返回该字段。
包含以下取值:

  • 0:不需要上传;
  • 1:等待上传,队列中;
  • 2:上传中;
  • 11:上传完成;
  • -1:上传失败;
  • 100:等待构建完成。

请求示例

GET https://open.volcengineapi.com?Action=ListImage&Version=2023-10-30&AccountId=21000xxxx&ImageId=img-xxxxx1&ImageIdList=img-xxxxx2,img-xxxxx3&ImageName=image-1459450162840xxxxxx&AospVersion=10&IsPublic=false&ImageStatus=11&Offset=0&Count=10&ExpandScope=false&ProductId=1591495366954xxxxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "ListImage",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "ImageId": "img-15xxxxxx",
                "CreateAt": 1722978531,
                "UpdateAt": 1722978531,
                "ImageName": "img-15xxxxxx-AOSP10-2100xxxxxx-自定义镜像",
                "ImageSize": 808861901,
                "AospVersion": "10",
                "ImageRemark": "test",
                "ImageStatus": 11,
                "PreheatStatus": 0,
                "ImageStatusStr": "BUILT",
                "AospVersionName": "AOSP10",
                "ImageDownloadUrl": "huanan-xxxxxx.tos-cn-xxxx.volces.com-xxxxxxxxxxxx",
                "ImageResourceType": "ARM_SoC",
                "UploadImageStatus": 0
            }
        ],
        "Total": 1
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。

最近更新时间:2026.02.04 11:20:46
这个页面对您有帮助吗?
有用
有用
无用
无用