升级实例镜像 UpgradeInstances--云手机-火山引擎

文档中心

立即注册

导航

升级实例镜像 UpgradeInstances

最近更新时间：2024.05.09 17:19:41首次发布时间：2023.08.23 16:34:11

升级指定实例的 Android 镜像（异步）使用方法如下：

调用本接口升级实例镜像，获取任务 ID（JobId）;
调用 GetJobDetails 接口，传入步骤 1 中获取的任务 ID，查看任务执行是否成功。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	UpgradeInstances
Version	Query	String	是	公共参数，OpenAPI 接口版本	2023-08-01

Body 参数

字段	类型	必填	说明
ProductId	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
InstanceIds	Array of String	是	执行镜像升级操作的实例 ID 列表，可通过调用 ListInstance 接口获取
ImageId	String	是	需要升级的镜像 ID，可通过调用 ListContainerImages 接口获取可用的自定义镜像
IsPublicImage	Boolean	否	镜像是否为公共镜像： true（在公共镜像列表中检索指定的镜像进行升级） false（在当前账号下检索指定的镜像进行升级，默认）

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
JobId	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
FailedList	Array of objects	失败的实例 ID 及对应错误信息列表，参考以下 FailedList 结构说明

FailedList 结构说明

字段	类型	说明
Id	String	实例 ID
Msg	String	操作失败的错误信息

示例

请求示例

POST https://open.volcengineapi.com?Action=UpgradeInstances
&Version=2023-08-01
&<通过header传入的公共请求参数>

{
    "ProductId": "14677396781xxxxxxxx",
    "ImageId": "img-55424258",
    "InstanceIds": ["i-1726334685xxxxxx","i-1726334685xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpgradeInstances",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "iPaaS",
        "Version": "2023-08-01"
    },
    "Result": {
        "JobId": "req-7072700279036072223",
        "FailedList": []
    }
}