查询镜像预热信息 GetImagePreheating--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询镜像预热信息 GetImagePreheating

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

查询指定镜像的预热进度。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImagePreheating`	接口名称。当前 API 的名称为 `GetImagePreheating`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
ImageIdList	String	是	`img-xxxxx1,img-xxxxx2`	指定需要查询的镜像 ID 列表。多个镜像 ID 使用英文 "," 分隔。列表最大长度为 100。
DcId	String	否	`gdsz-ctcucm-01-xxxxx`	机房 ID。用于指定希望查询的镜像所在的特定机房。若该参数置空，系统将默认返回所有机房中的指定镜像的预热数据。

返回参数

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

参数	类型	示例值	描述
Row	Array of ImagePreheating	`-`	镜像预热数据。参看 ImagePreheating 数据结构。

ImagePreheating

参数	类型	示例值	描述
ImageId	String	`img-xxxxx1`	镜像 ID。
PreheatFailedProgress	Integer	`5`	镜像预热失败的比例，单位为 %。
PreheatSuccessProgress	Integer	`90`	镜像预热完成的比例，单位为 %

请求示例

GET https://open.volcengineapi.com?Action=GetImagePreheating&Version=2023-10-30&ProductId=1749281594201xxxxxx&ImageIdList=img-xxxxx1,img-xxxxx2&DcId=gdsz-ctcucm-01-xxxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "GetImagePreheating",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "ImageId": "img-xxxxx1",
                "PreheatFailedProgress": 5,
                "PreheatSuccessProgress": 90
            },
            {
                "ImageId": "img-xxxxx2",
                "PreheatFailedProgress": 0,
                "PreheatSuccessProgress": 100
            }
        ]
    }
}

错误码

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