You need to enable JavaScript to run this app.
导航
预启服务
最近更新时间:2025.01.20 15:42:49首次发布时间:2024.04.19 13:53:04

启动云端游戏服务,但不进行推流。

注意事项

调用接口启动云端游戏服务之前,需确保已上架游戏、已配置运行游戏的资源套餐且套餐资源充足。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGamePreStart接口名称。当前 API 的名称为 GamePreStart
VersionString2023-03-18接口版本。当前 API 的版本为 2023-03-18

Body

参数类型是否必选示例值描述
GameIdString7067374083209xxxxxx游戏 ID,可通过调用 ListGame 接口获取。GameId 和 CustomGameId 二选一,同时指定时 GameId 优先。
CustomGameIdStringid1游戏标识,在注册游戏时指定。GameId 和 CustomGameId 二选一,同时指定时GameId 优先。
ClientUserIdStringuser-name唯一用户身份标识,由业务方自定义,用于标识用户在游戏房间中的身份,在用户重连时需保持 ClientUserId 不变。与调用服务端 PreAllocateResource 和 GameStop 接口时指定的 ClientUserId 相同。
ClientUserIpString220.xxx.xx.xxx用户设备 IP 地址。服务根据该 IP 选取最近的机房;如不指定,服务将自动从请求中解析。
UserTagStringnew_user_01用户属性。
ExpireTimeLong120自动回收服务资源的时间,单位为秒。表示从接收到启动游戏回调开始计时,如不设置或设置为 0,则不自动回收服务。
ExtraJSON Map-根据业务需要,自定义附加参数。key 和 value 均为 String。

返回参数

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

参数类型示例值描述

ReservedId

String

preStart-7250017187375xxxxxx

云端游戏服务预启成功,返回预启会话 ID,可用于后续通过客户端拉流、查询服务状态,停止预启服务等操作。

说明

预启服务的有效期默认为 7 天。

请求示例

POST https://open.volcengineapi.com?Action=GamePreStart&Version=2023-03-18
{
   "GameId": "7067374083209xxxxxx",
    "ClientUserId": "user-name",
    "ClientUserIp": "220.xxx.xx.xxx",
    "ExpireTime": 120,
    "Extra": {},
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GamePreStart",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "ReservedId": "preStart-7250017187375xxxxxx"
    }
}

错误码

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