清理用户数据 PodDataDelete--云手机-火山引擎

文档中心

立即注册

导航

云手机

清理用户数据 PodDataDelete

最近更新时间：2024.11.22 15:14:34首次发布时间：2024.05.08 15:07:04

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

使用说明

注意：用户数据删除后不可恢复，请谨慎操作。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PodDataDelete`	接口名称。当前 API 的名称为 `PodDataDelete`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954xxxxxx`	实例所归属的业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7294157141458xxxxxx`	实例 ID，可通过调用 `ListPod` 接口获取。
FilePathList	Array of String	是	`["/sdcard"]`	待清理数据的路径列表；仅支持清理 `/sdcard` 和 `/data` 目录下的数据，避免误删除。
PackageList	Array of String	否	`["Package1", "Package2"]`	按应用包名，清理已安装第三方应用的数据（系统应用不支持）。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7294234652162xxxxxx`	实例数据删除任务 ID，用于通过 `GetTaskInfo` 接口查看任务执行状态及结果。
TaskAction	String	`PodDataDelete`	任务类型，默认为对应接口 Action 名称，此处为 `PodDataDelete`。

请求示例

POST https://open.volcengineapi.com?Action=PodDataDelete&Version=2023-10-30
{
    "ProductId": "1591495366954xxxxxx",
    "PodId": "7294157141458xxxxxx",
    "FilePathList": [
        "/sdcard"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280xxxxxx",
        "Action": "PodDataDelete",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "7294234652162xxxxxx",
        "TaskAction": "PodDataDelete"
    }
}

错误码

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