删除业务 DeleteProduct--云游戏-火山引擎

文档中心

立即注册

导航

删除业务 DeleteProduct

最近更新时间：2025.01.20 15:42:50首次发布时间：2024.04.19 13:53:05

本接口支持删除指定平台下已创建的云游戏业务。

使用说明

删除业务前，需确保该业务下已无云端实例和游戏等资源。您可在云游戏控制台查询待删除业务详情。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DeleteProduct&Version=2023-03-18

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
GameType	String	是	`android`	游戏平台标识，缺省情况下查询全部平台业务。取值如下所示： `android`：云游戏手游业务 `pc`：云游戏端游业务
ProductId	String	是	`17040177780xxxxxxxx`	需要删除的云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。

GameType

String

是

android

游戏平台标识，缺省情况下查询全部平台业务。取值如下所示：

android：云游戏手游业务
pc：云游戏端游业务

ProductId String 是 17040177780xxxxxxxx 需要删除的云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。

返回参数

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

参数	类型	示例值	描述
Result	String	`success`	业务删除成功，返回 `success`，否则返回错误。

请求示例

POST https://open.volcengineapi.com?Action=DeleteProduct&Version=2023-03-18
{
    "GameType": "android",
    "ProductId": "17040177780xxxxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DeleteProduct",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Result": "success"
    }
}

错误码

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