游戏修改--云游戏-火山引擎

文档中心

立即注册

导航

游戏修改

最近更新时间：2025.01.20 15:42:48首次发布时间：2022.04.28 15:51:34

通过指定游戏 ID，更新已注册游戏的自定义游戏 ID、游戏名称和游戏横竖屏。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
game_id	String	是	指定游戏 ID，可通过调用 ListGame 接口获取
custom_game_id	String	否	新的自定义游戏 ID
game_name	String	否	新的游戏名称
game_rotation	String	否	更新后的游戏横竖屏： landscape（横屏显示） portrait（竖屏显示）
user_config_path_list	String[]	否	保存用户游戏配置文件的路径列表

返回结果

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

字段	类型	说明
Result	String	游戏信息修改成功，返回 success

示例

请求示例

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

{
    "game_id": "1493071161301xxxxxx",
    "custom_game_id": "new_game_01",
    "game_name": "修改的游戏名",
    "game_rotation": "portrait"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateGame",
        "Region": "cn-north-1",
        "RequestId": "20220216121046010225243139010ECE8A",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}