You need to enable JavaScript to run this app.
导航
云游戏
  • 文档首页
    • /云游戏/云游戏手游/服务端 OpenAPI 文档/服务管理/查询服务状态
查询服务状态
最近更新时间：2025.01.20 15:42:49首次发布时间：2023.08.01 18:56:13
我的收藏

本接口支持查询云端游戏服务状态。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetGameSessionStatus接口名称。当前 API 的名称为 GetGameSessionStatus。
VersionString是2023-03-18接口版本。当前 API 的版本为 2023-03-18。
GameIdString否9028301139游戏 ID，您可通过调用 ListGame 接口获取。当同时传入 CustomGameId 和 GameId 时，将优先使用 GameId。
CustomGameIdString否892031游戏标识，您在注册游戏时自定义的标识。当同时传入 CustomGameId 和 GameId 时，将优先使用 GameId。
ReservedIdString是8893719001游戏预启会话 ID，通过调用 GamePreStart 接口返回。

返回参数

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

参数类型示例值描述

Status

Integer

1

云端游戏服务状态，取值如下所示：

  • 1：运行中
  • 2：没有查询到相关游戏运行信息
  • 3：已结束

请求示例

GET https://open.volcengineapi.com?Action=GetGameSessionStatus&Version=2023-03-18&GameId=7067374083209xxxxxx&ReservedId=preStart-7250017187375xxxxxx

返回示例

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

错误码

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