停止服务--云游戏-火山引擎

文档中心

立即注册

导航

停止服务

最近更新时间：2025.01.20 15:42:50首次发布时间：2024.04.19 13:53:05

本接口支持关闭指定游戏服务。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GameStop`	接口名称。当前 API 的名称为 `GameStop`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。

Body

参数	类型	是否必选	示例值	描述
GameId	String	否	`7067374083209xxxxxx`	游戏 ID，可通过调用 ListGame 接口获取返回的游戏 ID。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。
CustomGameId	String	否	`21309297309`	用户自定义游戏 ID。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。
ClientUserId	String	是	`user-name`	自定义客户端用户 ID，流媒体服务客户端拉流所用 User ID。与通过客户端 SDK start() 接口申请游戏服务时指定的自定义客户端用户 ID 相同。
ReservedId	String	否	`7077141790263991084`	资源预锁定 ID，通过调用 PreAllocateResource 接口获取，或通过客户端 SDK `start()` 接口成功回调。

返回参数

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

参数	类型	示例值	描述
GameId	String	`7067374083209xxxxxx`	游戏 ID
CustomGameId	String	`981730910`	用户自定义游戏 ID
ClientUserId	String	`user-name`	自定义客户端用户 ID
ReservedId	String	`7077141790263991084`	资源预锁定 ID
PodStopStatus	Integer	`2`	执行停止云游戏服务的结果： `1`：正常执行 stop 指令 `2`：不执行 stop 指令：服务已释放无需再执行 stop `3`：不执行 stop 指令：参数异常，例如游戏 ID 与当次游戏的生命周期不匹配

请求示例

POST https://open.volcengineapi.com?Action=GameStop&Version=2023-03-18
{
    "GameId": "7067374083209xxxxxx",
    "ClientUserId": "user-name",
    "ReservedId": "7077141790263991084"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GameStop",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "GameId": "7067374083209xxxxxx",
        "ClientUserId": "user-name",
        "ReservedId": "7077141790263991084",
        "PodStopStatus": 2
    }
}

错误码

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