删除实例 DeletePod--云手机-火山引擎

文档中心

立即注册

导航

云手机

删除实例 DeletePod

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.05.08 16:33:54

删除指定的单个或多个实例，并清理实例上的所有数据。

使用说明

批量操作删除时，支持删除至多 100 个实例。
本接口默认仅删除处于“已关机”状态的实例，可使用 ListPod 接口的 OnlineList 参数筛选符合条件的实例。如需强制删除运行中的实例，可将 ForceDestroyFlag 参数设置为 true。

注意事项

一经删除，实例上的全部数据将直接被清理，并且无法恢复，请谨慎操作。
本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954******`	实例所归属的业务 ID，可登录云手机控制台，在已创建的业务卡片中获取。
PodId	String	否	`7294107154305******`	待删除的实例 ID，若仅需删除单个实例，请使用本参数。说明批量删除实例请使用 `PodIdList` 参数。
PodIdList	Array of String	否	`["7294107154305****","7294107154306****"]`	待删除的实例 ID 列表，若需批量删除多个实例，请使用本参数。说明删除单个实例请使用 `PodId` 参数。支持删除至多 100 个实例。
ForceDestroyFlag	Boolean	否	`false`	是否强制删除运行中的实例。包含以下取值： `true`：是，忽略实例的运行状态，强制删除实例； `false`：（默认）否，若传入的实例仍在运行，则接口返回失败。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=DeletePod&Version=2023-10-30
{
    "ProductId": "1591495366954******",
    "PodId": "7294107154305******",
    "ForceDestroyFlag": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DeletePod",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

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