【旧版】销毁实例 DestroyPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】销毁实例 DestroyPod

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

销毁创建的实例，同时将清除用户数据。

注：实例销毁后，实例上的所有用户数据将直接被清除，并且无法还原，请谨慎操作。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id	string	否	实例 ID，指定该参数时，仅销毁单个实例与 pod_id_list 二选一
pod_id_list	[]string	否	实例 ID 列表，指定该参数时，批量销毁多个实例（支持批量操作的实例数上限为100）与 pod_id 二选一
force_destroy_flag	bool	否	是否强制销毁实例： true：支持开机状态下销毁实例 false：默认，不强制销毁实例，如不填写，在开机状态调用本接口销毁实例时会失败

返回结果

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

示例

请求示例

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

{
    "product_id":"1591495366954xxxxxx",
    "pod_id":"7294107154305xxxxxx",
    "force_destroy_flag": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DestroyPod",
        "Region": "cn-north-1",
        "RequestId": "202310261527598040B5D35F9DEEFAD8F9",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8060003	正在操作实例, 上次操作完成前禁止再次操作	等待操作完成后重试
8060005	操作的实例数量超过批量操作上限	参考说明文档，检查可批量执行的实例数量上限，建议减少并发请求
8060011	禁止删除实例	检查实例状态，确保实例可删除