文档中心

控制台指南

最近更新时间：2023.12.28 16:46:30

首次发布时间：2022.09.23 14:17:49

本章节为您介绍在控制台配置云游戏端游业务的主要操作步骤，包括查看业务概览、新建业务、购买实例资源、上架游戏等主要操作。

快速开始

登录云游戏控制台后，可点击页面左上角的 新手引导，打开云游戏控制台新手引导页面。

新手引导页面提供创建业务、订购资源、上架游戏、接入 SDK（下载最新版本的客户端 SDK 包文件）的指引，帮助您完成云游戏服务接入。

业务概览

数据统计

打开云游戏控制台后，即可通过「概览」页面查看业务的运行数据，包括：

前一日业务维度的用户游戏总时长、请求总数、用户总数、在线并发峰值，以及较上一周的同比数据
业务维度的资源订购总量和资源订购走势（包括预付费、后付费和免费资源的数据）
最近一周的带宽用量数据，包括当日带宽峰值和当月带宽95峰值

更多业务运行详细数据，可通过云游戏端游模块下的数据监控看板查询。

计费详情

在「概览」页面可查看当前账号的计费详情，通过链接打开火山引擎费用中心查看账户总览、管理预付费资源订单或查看后付费资源账单详情。

鉴权密钥

在「概览」页面可生成鉴权密钥，对接入云游戏服务的用户进行鉴权。在测试接入阶段，可生成临时鉴权密钥体验接入；正式接入云游戏服务时，需要通过调用服务端接口生成正式鉴权密钥。

生成临时鉴权密钥

点击 临时鉴权密钥，在弹窗中输入临时鉴权密钥的生效时长，输入火山引擎账号的 Access Key 和 Secret Access Key（可通过火山引擎控制台页面右上角 用户信息 > API访问密钥 获取）。
点击 生成临时密钥。保存生成的临时密钥信息，包括密钥的创建时间、失效时间、临时 Access Key ID、Secret Access Key、和 Session Token。

下载云游戏客户端 Quick Start 示例文件。在示例代码中，填入生成的临时鉴权密钥参数，即可快速体验云游戏服务。Web/H5 客户端需要填入鉴权密钥的示例代码如下（config.js 文件）：

// 实例化 veGameSDK 的参数
const initConfig = {
  userId: '', // 必填参数，开发者可进行自定义，用于标识游戏玩家或账号等
  accountId:'', // 必填参数，火山引擎账号ID，可通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取
  mode: window.veGameSDK.MODE.CLOUD_PC, // 如果需要控制云游戏手游，请传 MODE.CLOUD_PHONE_GAME
  isPC: true, // 在桌面应用程序运行SDK
};

// 调用 veGameSDK.start 的参数
const startConfig = {
  gameId: '7112633605523xxxxxx', // 游戏ID
  token: {
      CurrentTime: '2023-10-12T15:37:43+08:00',    // Token创建时间
      ExpiredTime: '2023-10-19T15:37:43+08:00',    // Token过期时间
      SessionToken: 'STS2ey......MifQ==',   // 用于鉴权的临时Token
      AccessKeyID: 'AKTPN......NWE',    // 用于鉴权的临时AccessKey
      SecretAccessKey: 'vKtZO......P7K' // 用于鉴权的临时SecretKey
  },
  roundId: '', //必填参数，开发者可进行自定义，用于标识当次游戏会话
  rotation: 'landscape', // landscape：横屏启动; portrait：竖屏启动
};

window.initConfig = initConfig;
window.startConfig = startConfig;

常用文档

「概览」页面还提供常用产品说明和参考文档的跳转链接，可在控制台页面内预览产品文档内容，也可在新窗口中打开云游戏产品文档中心。

新建业务

业务管理页面为主账号用户提供创建和管理云游戏端游业务的功能。通过创建不同的业务，可高效地管理不同的应用场景所需的实例资源和游戏资源。新建云游戏端游业务的步骤如下：

在控制台左侧导航栏中，进入「云游戏端游 > 业务管理」页面，点击 新建业务。
在弹窗中填写业务名称和业务描述后，点击确定。
业务创建成功后，新建的业务将显示在「业务管理」页面。业务卡片展示该业务已订购的资源数量、已上架的游戏数量、业务 ID 和业务创建时间。
点击 业务配置，可以查看或编辑业务的基本信息、配置接收回调信息的地址和鉴权参数、配置游戏的资源文件信息、以及设置无操作踢下线和实例保活时长等高级配置。
点击 进入业务，可以为新建的业务购买实例资源、上传游戏、开展后续业务等。

业务配置管理

业务配置页面支持查看和编辑业务的基本信息、配置回调服务接入信息、游戏配置文件信息和游戏运行相关的设置。

业务创建完成后，点击 业务配置。
在 基本信息 一栏中，可查看生成的业务 ID（在调用云游戏服务端 OpenAPI 时，业务 ID 是常用的请求参数）；点击编辑，可修改业务名称和描述信息。
在 回调配置 一栏中，可点击编辑，然后按业务需要配置回调参数（通过设置回调地址可以在服务端及时收到游戏运行时的相关消息）。回调地址及回调鉴权信息配置步骤如下：
- 回调地址： 输入支持 HTTP 的回调地址 URL；
- 回调鉴权 AK/SK： 输入用于回调鉴权的 AK 和 SK（AccessKey ID 和 AccessKey Secret），或点击 生成鉴权秘钥 按钮，自动生成密钥；
- 回调间隔时长： 输入定期发送回调信息的间隔时间（单位为秒）；
- 点击确认，保存配置。此时可点击回调地址旁的验证，校验配置的回调地址是否可用。
在 配置文件信息 一栏中，可点击编辑，配置游戏的资源文件信息（供此业务下所有游戏共享使用）；配置步骤如下：
- 配置文件路径： 输入在云端保存资源文件的路径（即游戏依赖的资源路径）；
- 配置文件 URL： 输入下载资源文件的 URL（当前仅支持 tgz 文件格式）；
- 点击 增加配置 可以配置多个资源文件信息（目前最多可配置10个资源文件信息）。
在 高级配置 一栏中，可点击编辑，然后按业务需要配置游戏运行相关的设置：
- 无操作踢下线： 输入用户长时间无操作时，回收游戏服务的时长（单位为秒，支持设置的最大值为36000，即10小时）；
- 实例保活时长： 输入客户端切后台之后，云端游戏服务的保活时长（单位为秒，支持设置的最大值为7200，即2小时）；
- 多开限制配置： 设置是否禁止同一个账号在多台设备上登录、并选择多开配置的策略；
- 点击确认，保存配置，此处的设置将对此业务下的全部游戏生效。

资源管理

在「业务管理」页面中，找到目标业务，点击 进入业务，即可打开「资源管理」页面。资源管理页面提供实例资源购买和管理功能。可按业务需要选择计费类型（包月预付费或按日订购峰值后付费），购买和管理实例资源。

预付费计费模式

在预付费计费模式下，资源管理页面提供实例资源购买、续费、退订入口及查看已购实例资源相关信息等功能。

购买实例资源

进入业务后，在「资源管理」页面，点击购买。
在「购买资源」页面中，选择 试用体验（提供1路实例试用7天；产生的流媒体带宽费用仍需按计费标准计费）或 正式购买（参考以下步骤）。
选择 包月预付费 计费类型。
选择需要购买的套餐名称、按业务需要输入购买的实例数量和租期、并选择是否开启自动续费（开启后，如账户余额足够，在实例资源到期前自动续费1个月）。
带宽计费类型目前仅支持按月95峰值计费，无需选择。
阅读并同意云游戏《产品服务条款》和《服务等级协议》，点击 确认订单。
在火山引擎费用中心确认购买的实例参数信息，根据页面提示完成支付。
支付成功后，返回「资源管理」页面，即可查看已购所有实例资源的相关信息。

续费或退订实例

续费

资源到期释放前，在「资源管理」页面选择一个或多个资源组，点击 批量续费（或点击资源组列表操作列下的 手动续费）。根据弹窗指示分别填写资源组的续费租期，确认预付款后点击确定，然后前往费用中心完成支付（注：试用套餐不支持续费）。

如需为已购资源组开通自动续费功能或修改自动续费配置，可点击资源组列表操作列下的 管理自动续费。前往火山引擎「费用中心 > 续费管理」页面，为已购资源组配置自动续费功能。

退订

如需退订实例资源，在「资源管理」页面选择一个或多个资源组，点击 批量退订（或点击资源组列表操作列下的退订）。根据弹窗指示确定需退订的实例总数和预计退款金额。

后付费计费模式

在后付费计费模式下，资源管理页面提供实例资源购买、实时修改订购数量等功能。

购买实例资源

进入业务后，在「资源管理」页面，点击购买。
在「购买资源」页面中，选择 试用体验（提供1路实例试用7天；产生的流媒体带宽费用仍需按计费标准计费）或 正式购买（参考以下步骤）。
选择 日订购峰值后付费 计费类型。
选择需要购买的套餐名称，阅读并同意云游戏《产品服务条款》和《服务等级协议》，点击 确认订单。

如有已购套餐，可通过修改订购数量对单个套餐进行增订和退订，不需要重复购买。

购买申请提交后，在弹窗中确认实例服务状态。返回「资源管理」页面，即可查看已购实例资源的相关信息。

修改订购数量

购买实例套餐后，可根据业务需要实时修改订购的实例数量。

打开「资源管理」页面，在已购套餐列表的操作栏中，点击 修改数量。在 实例数量 栏中输入需订购的实例数量，然后点击保存即可。

注意

增加订购数量时，如果遇到线上余量不足的情况，可联系火山引擎商务对接人员；
如需减少订购数量，请先检查并确认业务当前线上的并发量，谨慎操作。

游戏管理

在「业务管理」页面中，找到目标业务，点击 进入业务。在左侧导航栏中，打开「游戏管理」页面。游戏管理页面提供游戏的新增、适配、部署管理、版本更新、下架等功能。
alt

新增游戏

点击进入「游戏管理」页面，点击 新增游戏。
填写游戏名称和游戏标识，并按需填写自定义游戏版本名称。游戏标识建议填写具有高可读性和可辨别性的字段，便于识别游戏。
输入游戏包内游戏启动文件的相对路径，支持中文、大小写字母、数字和特殊符号，例如：/mygame_1/ABC.exe。
按需填写启动游戏需要配置的其他依赖参数，支持中文、大小写字母、数字和特殊符号。

注意：提供的启动路径和启动参数信息将用于游戏适配和游戏启动，填写错误可能导致游戏适配和启动失败。

选择通过 本地上传 或 URL 上传游戏安装包。请勿重复上传相同的游戏安装包。有关游戏安装包的打包规则，参考游戏打包规则。游戏打包需注意以下几点：
- 必须上传经过打包规则处理完成后的游戏安装包，任何不符合规则的安装包都有可能导致游戏适配失败。
- 上传格式是游戏安装包文件夹，文件夹中的错误文件会被自动剔除，建议上传前检查安装包中不要带有多余的文件或缺少文件。
- 游戏上传会根据当前网速和游戏大小提示预估上传时间，请密切关注上传进度，如因异常导致上传中断，请点击重试。
游戏安装包上传过程中，请勿关闭页面。待安装包上传完成后，点击确定。

alt

新增游戏操作完成后，游戏进入 适配中 状态。

alt

游戏上传完成后，我们将开始游戏适配工作。适配完成后，游戏将进入 上架完成 状态。

注：在游戏适配过程中，如需终止游戏发布，可在游戏列表中点击进入 版本管理 页面，然后在游戏版本列表中点击 取消发布。取消发布后，可重新配置游戏信息后再次部署）。

配置部署策略

游戏上传完成后，可以为游戏添加部署策略，配置运行游戏的实例套餐以及调度优先级（1为最高）。游戏启动时将根据优先级和资源使用情况启动实例套餐。

通过「资源管理」页面，按需购买实例资源。
购买实例资源后，在游戏列表的操作栏中，点击 部署管理。

alt

在「部署管理」弹窗中，点击 添加部署策略。在 套餐名称 下拉菜单中选择运行游戏的实例套餐。如需配置多个实例套餐，再次点击 添加部署策略，并配置次优先级的实例套餐（如需调整已配置套餐的调度优先级，可上下拖动某一行配置项进行快速调整）。完成配置后，点击确定。

alt

完成部署策略配置且游戏已进入 上架完成 状态后，可通过云游戏客户端 SDK 提供的 start() 接口，指定启动游戏的 ID 或自定义游戏标识，申请云游戏服务。
如需删除已配置的部署策略，在「部署管理」弹窗中，点击操作列中的删除即可（若游戏的部署策略配置为 “未配置” 时，客户端开始游戏时会报错）。

配置启动路径参数

游戏上传完成后，可通过以下步骤修改游戏的启动路径和启动参数：

在游戏列表的操作列中，点击进入「版本管理」页面。
在游戏版本列表中，点击操作列中的 启动配置，更新游戏的启动路径和启动参数信息。

alt

点击确定，保存游戏启动配置信息。

更新游戏

在游戏列表的操作栏中，点击进入「版本管理」页面，查看游戏的历史版本信息。
点击 更新游戏，选择更新游戏的类型（完整包或增量包），输入自定义版本名称。
按需填入新的游戏启动路径和启动参数；如无变更，可点击 自动填入，使用游戏已配置的启动路径和启动参数。
选择通过 本地上传 或 URL 上传 新版本游戏安装包（请勿重复上传相同版本的游戏安装包）。

alt

游戏安装包上传完成后，点击确定，上传新版本游戏安装包，游戏进入 新版本适配中 状态。
系统会自动开始新的游戏版本适配工作。待游戏版本适配完成后，游戏进入 上架完成 状态。

下架游戏

在游戏列表的操作栏中，点击 ... > 下架，可下架和删除游戏。

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

alt

数据监控

数据监控页面提供查看和监控当前云游戏业务运行数据的功能。查看和监控业务数据的步骤如下：

在控制台左侧导航栏中，进入「云游戏端游 > 数据监控」页面。
在 资源订购 标签页下，可查询业务维度的资源订购总量和资源订购走势。
在 实时数据 标签页下，可查询业务和游戏维度在指定时间区间内的实时数据，包括实时在线并发数量、客户端请求数量和服务请求成功率。
在 累计数据 标签页下，可查询业务和游戏维度在指定时间区间内的累计数据，包括累计用户时长和活跃用户数（注：系统会在1-2日内对累计数据进行校准）。
在 带宽用量 标签页下，可查询当前账号在指定时间区间内产生的带宽用量趋势（不区分手游和端游），包括当日带宽峰值和当月带宽95峰值。