分配有效负载 (Clanforge)
Note: The content on this page pertains to Managed Game Server Hosting (Clanforge). Refer to Allocations Payload for the Game Server Hosting (Multiplay) version of this page.
分配有效负载功能允许您在服务器分配请求中发送任何文件作为有效负载。此功能提供了一种按匹配方式配置游戏的方法。有效负载通过 分配 V2 端点上传后，您可以在游戏进程中检索它。分配结束后，与该分配关联的有效负载将不再可用。请参阅 有效负载生命周期。
限制
分配有效负载功能具有以下限制
- 有效负载不能超过 30 KB。对于有效负载大小超过限制的分配，端点会以 400 状态拒绝分配。
- 您可以将有效负载作为 分配 V2 beta 端点分配的一部分。
- 您可以使用 解除分配 V2 beta 端点移除有效负载。
有效负载生命周期
有效负载是与特定分配绑定的临时、基于会话的数据。与有效负载关联的分配解除分配后，有效负载将不再可用。
在满足以下条件之一之前，可以检索有效负载
- 游戏服务器通过解除分配端点解除分配。分配的生命周期完成后，游戏服务器托管会清除与分配 UUID 相关的所有数据。
- 有效负载达到其生存时间 (TTL)。分配超时值在 舰队扩展设置 中设置有效负载 TTL，默认情况下为一小时，如果未在舰队级别设置则为一小时。
发送有效负载
要在分配请求中发送文件，请将 X-Enable-Payload 标头设置为 true。然后，您可以将文件附加到请求正文。此文件可以是任何格式，您可以在分配的生命周期内检索它。
Note: In the future, the requirement for the X-Enable-Payload header flag will be phased out.
Multiplay API URL:
https://api.multiplay.co.uk示例请求
curl --location --request POST 'https://api.multiplay.com/cfp/v2/fleet/<fleetid>/server/allocate?regionid=<regionid>&profileid=<profileid>&uuid=<allocation_uuid>&project_guid=<project_guid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'\
--header 'X-Enable-Payload: true' \
--header 'Content-Type: text/plain' \
--data-raw 'This can be anything.'示例响应
{
"success": true,
"messages": [],
"allocation": {
"profileid": <profileid>,
"uuid": "<uuid>",
"regions": "<regionid>",
"requested": "<requesteddate>",
"created": "<createddate>",
"fleetid": "<fleetid>"
}
}检索有效负载
分配请求完成后，您可以从游戏服务器访问有效负载。向有效负载代理发送请求，有效负载代理在游戏服务器机器上本地可用，以从游戏服务器检索有效负载文件。有效负载代理是一个可在端口 8086 上访问的服务，与游戏服务器并行运行。此外，它还检索通过分配端点上传的有效负载。
Note: Use the server.json file to get a server’s allocation UUID.
示例请求
curl -X GET https://:8086/payload/<allocation_uuid>示例响应
HTTP/1.1 200 OK
Date: Mon, 26 Jul 2021 17:00:33 GMT
Content-Length: 23
Content-Type: text/plain; charset=utf-8
This can be anything.