【旧版】清理用户数据 PodDataDelete--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】清理用户数据 PodDataDelete

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

清理指定实例中的用户数据（异步任务）。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id	string	是	实例 ID
file_path_list	list	是	待清理数据的路径列表；仅支持清理 `/sdcard` 和 `/data` 目录下的数据，避免误删除
package_list	list	否	按应用包名，清理已安装第三方应用的数据（系统应用不支持）

返回结果

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

Result 字段包含以下参数：

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

Job 数据格式

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

示例

请求示例

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

{
    "product_id":"1591495366954xxxxxx",
    "pod_id":"7294157141458xxxxxx",
    "file_path_list":["/sdcard"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PodDataDelete",
        "Region": "cn-north-1",
        "RequestId": "20231026195857A5C192B10AD621073652",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7294234652162xxxxxx",
        "task_action": "PodDataDelete"
    }
}