游戏下架--云游戏-火山引擎

文档中心

立即注册

导航

游戏下架

最近更新时间：2025.01.20 15:42:48首次发布时间：2022.03.01 17:31:35

在某个业务下，下架并删除指定游戏。

注意

游戏下架后，会同时删除该游戏的版本和部署策略。如果有实例正在推流这个游戏，则不能删除游戏。如果需要重新申请此游戏服务，需要重新上架游戏。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
game_id	String	否	游戏 ID，可通过调用 ListGame 接口获取当传入 custom_game_id 时，可不传入（以 game_id 优先）
custom_game_id	String	否	用户自定义游戏 ID，可通过调用 ListGame 接口获取当传入 game_id 时，可不传入

字段

类型

必填

说明

game_id

String

否

游戏 ID，可通过调用 ListGame 接口获取

当传入 custom_game_id 时，可不传入（以 game_id 优先）

custom_game_id

String

否

用户自定义游戏 ID，可通过调用 ListGame 接口获取

当传入 game_id 时，可不传入

返回结果

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

字段	类型	说明
Result	String	游戏下架成功，返回 success

示例

请求示例

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

{
    "game_id": "1493071161301xxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DeleteGame",
        "Region": "cn-north-1",
        "RequestId": "20220216141701010225243147021D40A7",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}