支持设置过滤条件或指定镜像 ID 查询镜像详情,包括镜像名称、大小、版本、状态以及构建时间等信息。
本接口的单用户 QPS 限制为 200 次/秒。超过限制,API 调用会被限流。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 |
| 接口名称。当前 API 的名称为 |
Version | String | 是 |
| 接口版本。当前 API 的版本为 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ProductId | String | 是 | 1749281594201xxxxxx | 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 |
ImageIdList | Array of String | 否 | ["img-xxxxx2", "img-xxxxx3"] | 镜像 ID 列表,可以指定多个需要查询的镜像,以英文逗号","分割。 |
ImageName | String | 否 | image-1459450162840xxxxxx | 镜像名称。 |
AOSPVersion | String | 否 | 10 | 镜像版本:
|
IsPublic | Boolean | 否 | true | 是否查找公共镜像:
|
ImageStatus | Integer | 否 | 1 | 镜像状态,不传值默认查询所有状态的镜像。
|
ExpandScope | Boolean | 否 | true | 是否查询未发布的公共镜像,包含以下取值:
|
MaxResults | Integer | 否 | 10 | 分页查询时设置的每页行数,取值范围:0 ~ 100 |
NextToken | String | 否 | AABCToken****** | 分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次 API 调用返回的 NextToken 参数值。NextToken 无效会从第一条记录开始返回,不会产生错误。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Row | Array of AOSPImage | - | 镜像列表。 |
NextToken | String | AABCToken****** | 分页查询时,返回的下一页的 Token。NextToken 有返回值时,可以根据返回值继续查询下一页数据;NextToken 没有返回值表示所有数据已查询完毕。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
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 | 镜像状态。可能值:
|
PreheatStatus | Integer | 0 | 镜像预热状态。可能值:
|
ImageStatusStr | String | BUILT | 镜像状态描述。 |
ImageDownloadUrl | String | huanan-xxxxxx.tos-cn-xxxx.volces.com-xxxxxxxxxxxx | 镜像下载地址。 注意 如需获取自定义镜像文件下载地址,请先联系技术支持团队获取权限,获取到权限后需重新构建镜像,方可返回该字段。 |
ImageResourceType | String | ARM_SoC | 镜像对应的适配架构类型。包含以下取值:
|
UploadImageStatus | Integer | 0 | 镜像上传状态。可能值:
注意 如需获取自定义镜像上传状态,请先联系技术支持团队获取权限,获取到权限后需重新构建镜像,方可返回该字段。 |
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******" } }
您可访问公共错误码,获取更多错误码信息。