【旧版】实例重置 ResetPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】实例重置 ResetPod

最近更新时间：2024.06.17 19:36:16首次发布时间：2023.06.14 12:45:14

对指定实例执行重置操作，清理应用和文件（异步任务），支持以下重置操作：

全部重置，清理应用和文件、包括通过 CreatePod 和 UpdatePodProperty 接口设置的实例属性
清除数据（应用和文件），但保留通过 CreatePod 和 UpdatePodProperty 接口设置的实例属性（注：已知问题，持久化属性需要实例重启后才能生效）

实例重置结果通过任务执行回调返回，详细信息，参考回调服务接入指南。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id_list	[]string	否	实例 ID 列表，对多个实例批量执行重置操作，支持的最大实例数量为 100
reset_type	int	否	实例重置操作方式： 0：全部重置，清理应用和文件、包括实例属性 1：清理应用和文件，但保留实例属性
data_size	string	否	重置后 data 分区容量大小，可选的容量如下（容量大小和单位不可自定义）： 4Gi 8Gi 12Gi 16Gi 22Gi 32Gi 45Gi 64Gi 128Gi 256Gi 注：如不指定，则默认使用 8Gi 容量（建议调用方在调用时，结合实际业务情况，按需填写存储大小，默认 8Gi 容量对部分业务会偏小）

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
task_id	string	实例重置任务 ID，用于通过任务信息查询接口查看任务执行状态及结果
task_action	string	任务类型，默认为对应接口 Action 名称，此处为 ResetPod
jobs	list	子任务列表，参考以下 Job 数据格式

Job 数据格式

字段	类型	说明
pod_id	string	实例 ID
job_id	string	子任务 ID，每个子任务对应一个实例

示例

请求示例

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

{
    "product_id":"1591495366954xxxxxx",
    "pod_id_list":["7294157141458xxxxxx"],
    "reset_type":1,
    "data_size":"12Gi"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ResetPod",
        "Region": "cn-north-1",
        "RequestId": "20231026153835185EBFF37762D6832654",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7294167524072xxxxxx",
        "task_action": "ResetPod",
        "jobs": [
            {
                "job_id": "job-7294167524072xxxxxx-7294107154305xxxxxx",
                "pod_id": "7294107154305xxxxxx"
            }
        ]
    }
}