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

云手机

复制全文
镜像管理
查询 AOSP 镜像列表 ListAOSPImage
复制全文
查询 AOSP 镜像列表 ListAOSPImage

支持设置过滤条件或指定镜像 ID 查询镜像详情,包括镜像名称、大小、版本、状态以及构建时间等信息。

注意事项

本接口的单用户 QPS 限制为 200 次/秒。超过限制,API 调用会被限流。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=ListAOSPImage&Version=2025-05-01

请求参数

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

Query

参数

类型

是否必选

示例值

描述

Action

String

ListAOSPImage

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

Version

String

2025-05-01

接口版本。当前 API 的版本为 2025-05-01

Body

参数

类型

是否必选

示例值

描述

ProductId

String

1749281594201xxxxxx

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

ImageIdList

Array of 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

true

是否查找公共镜像:

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

ImageStatus

Integer

1

镜像状态,不传值默认查询所有状态的镜像。

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

ExpandScope

Boolean

true

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

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

MaxResults

Integer

10

分页查询时设置的每页行数,取值范围:0 ~ 100

NextToken

String

AABCToken******

分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次 API 调用返回的 NextToken 参数值。NextToken 无效会从第一条记录开始返回,不会产生错误。

返回参数

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

参数

类型

示例值

描述

Row

Array of AOSPImage

-

镜像列表。

NextToken

String

AABCToken******

分页查询时,返回的下一页的 Token。NextToken 有返回值时,可以根据返回值继续查询下一页数据;NextToken 没有返回值表示所有数据已查询完毕。

AOSPImage

参数

类型

示例值

描述

ImageId

String

img-15xxxxxx

镜像 ID。

CreateAt

Long

1722978531

构建任务创建时间,Unix 秒级时间戳。

UpdateAt

Long

1722978531

构建任务更新时间,Unix 秒级时间戳。

ImageName

String

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

镜像名称。

ImageSize

Long

808861901

镜像大小,单位 byte。

AOSPVersion

String

10

镜像版本。

ImageRemark

String

test

镜像描述。

ImageStatus

Integer

11

镜像状态。可能值:

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

PreheatStatus

Integer

0

镜像预热状态。可能值:

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

ImageStatusStr

String

BUILT

镜像状态描述。

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:等待构建完成。

注意

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

请求示例

POST https://open.volcengineapi.com?Action=ListAOSPImage&Version=2025-05-01
{
    "ProductId": "1749281594201xxxxxx",
    "ImageIdList": [
        "img-xxxxx2",
        "img-xxxxx3"
    ],
    "ImageName": "image-1459450162840xxxxxx",
    "AOSPVersion": "10",
    "IsPublic": true,
    "ImageStatus": 1,
    "ExpandScope": true,
    "MaxResults": 10,
    "NextToken": "AABCToken******"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListAOSPImage",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "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",
                "ImageDownloadUrl": "huanan-xxxxxx.tos-cn-xxxx.volces.com-xxxxxxxxxxxx",
                "ImageResourceType": "ARM_SoC",
                "UploadImageStatus": 0
            }
        ],
        "NextToken": "AABCToken******"
    }
}

错误码

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

最近更新时间:2026.01.28 16:04:09
这个页面对您有帮助吗?
有用
有用
无用
无用