查询镜像分布 ListImageResource--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询镜像分布 ListImageResource

最近更新时间：2024.10.29 19:17:20首次发布时间：2024.08.08 14:51:25

查询当前业务下使用的所有镜像 ID，以及每个镜像所关联的实例数量。
查询结果为调用接口前最后一次数据库刷新的数据，而非实时数据。如果在最后一次数据库刷新之后至本次接口调用期间有新镜像被实例化，这些新增实例将不会被包含在返回的结果中。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListImageResource`	接口名称。当前 API 的名称为 `ListImageResource`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
ImageIdList	String	否	`img-xxxxx1,img-xxxxx2`	指定需要查询的镜像 ID 列表。多个镜像 ID 使用英文 "," 分隔。该参数置空时，系统将默认返回业务下所有镜像 ID 的分布情况。
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。

返回参数

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

参数	类型	示例值	描述
Row	Array of ImageResource	`-`	镜像分布信息，参看 ImageResource 数据结构。
Total	Long	`1`	查询结果总组数。

ImageResource

参数	类型	示例值	描述
ImageId	String	`img-xxxxx1`	镜像 ID。没有 ID 时显示镜像地址。若某镜像未被实例化，即对应的 PodNum 为 0，且非已预热镜像，则不予展示。
PodNum	Long	`2`	当前镜像被实例化的数量，包括所有已启动（开机）和未启动（未开机）的实例。

请求示例

GET https://open.volcengineapi.com?Action=ListImageResource&Version=2023-10-30&ProductId=1749281594201xxxxxx&ImageIdList=img-xxxxx1,img-xxxxx2&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListImageResource",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "PodNum": 2,
                "ImageId": "img-xxxxx1"
            }
        ],
        "Total": 1
    }
}

错误码

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