重置实例镜像 ResetInstances--云手机-火山引擎

文档中心

立即注册

导航

重置实例镜像 ResetInstances

最近更新时间：2024.05.09 17:19:41首次发布时间：2023.01.11 16:55:50

重置云手机实例的镜像（异步），使用方法如下：

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

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ResetInstances
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
image_id	String	是	镜像 ID
is_public_image	Boolean	否	镜像是否为公共镜像： true（在公共镜像下检索指定的镜像进行重置） false（在当前账号下检索指定的镜像进行重置，默认）
instance_id_list	String[]	是	实例 ID 列表，可通过调用 ListInstance 接口获取

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
job_id	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
failed_list	Array of objects	镜像重置任务下发失败的实例 ID 列表及对应错误信息列表，参考以下 `List<CaseWithMsg>` 结构说明

List<CaseWithMsg> 结构说明

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

示例

请求示例

POST https://open.volcengineapi.com?Action=ResetInstances
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "product_id": "14677396781xxxxxxxx",
    "image_id": "img-55424258",
    "instance_id_list": ["i-1726334685xxxxxx","i-1726334685xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ResetInstances",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-7072700279036072223",
        "failed_list": []
    }
}