批量停止指定 ReservedId 的云游戏服务。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考 公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | BatchStopGame | 接口名称。当前 API 的名称为 BatchStopGame。 |
| Version | String | 是 | 2023-03-18 | 接口版本。当前 API 的版本为 2023-03-18。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ProductId | String | 是 | 73738906**827381003 | 云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。 |
| StopInfoList | Array of StopInfoList | 是 | - | 停止信息列表，列表元素数量上限为 100。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ReservedId | String | 是 | 736923556**42295079 | 资源预锁定 ID，通过调用 PreAllocateResource 或 GamePreStart 接口返回，或通过客户端 SDK start() 接口回调。 |
| Extra | JSON Map | 否 | - | 自定义参数，透传给实例。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| FailedReservedIdList | Array of String | - | 执行停止游戏失败的 ReservedId，该字段为空表示全部执行成功。 |
POST https://open.volcengineapi.com?Action=BatchStopGame&Version=2023-03-18
{
"ProductId": "73738906**827381003",
"StopInfoList": [
{
"ReservedId": "736923556**42295079"
}
]
}
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "BatchStopGame",
"Version": "2023-03-18",
"Service": "vegame",
"Region": "cn-north-1"
},
"Result": {}
}
您可访问公共错误码，获取更多错误码信息。