图像版本创建
警告：这里的 API 文档适用于托管游戏服务器托管 (Clanforge)。如果您使用的是游戏服务器托管 (Multiplay)，请参阅 游戏服务器 API 文档.
为由指定镜像差异 <diffid> 标识的镜像创建新的镜像版本。
如果镜像差异分析没有变化，它将创建一个完整镜像，而不是部分镜像。
最佳做法是通过将 full 变量设置为 1 来定期创建完整镜像，以防止镜像变得过大，这会导致在扩展到云时部署速度变慢。请参阅 镜像卷起频率.
https://api.multiplay.co.uk/cfp/v1/imageversion/create方法 |
| GET |
请求参数
| 变量 | 描述 | 可选 |
| diffid | <diffid> 参数接受已完成镜像差异分析的 ID。 | 否 |
| restart | <restart> 参数接受一个布尔值，指定在更新完成后是否重新启动使用更新后的游戏镜像的所有游戏服务器。如果设置为 如果设置为 | 否 |
| accountserviceid | <accountserviceid> 是与指定资源关联的账户服务 ID (ASID)。请求标头中的凭据必须具有访问 ASID 的权限才能执行请求。 | 否 |
| full | <full> 参数是如果设置为 如果省略或设置为 如果 如果尝试在上次安装为完整安装并且 | 是 |
| game_build | <game_build> 参数是一个可选参数，接受一个字符串值，该值标识游戏的内部构建。这以前是 game_version。如果给出，则在成功完成时，Clanforge 游戏版本的 | 是 |
| force | <force> 参数是一个布尔值，指定是否即使存在活动分配也要强制创建镜像版本。如果设置为 如果设置为 默认情况下，如果您在发出此请求时存在活动分配，则它将失败。要绕过此行为并强制创建镜像版本，请将 | 是 |
| install_at | <install_at> 参数是表示作业预计开始时间的 Unix 时间戳。 | 是 |
| disable_timeout | <disable_timeout> 参数与 <disable_percentage> 结合使用，以便比默认的 4 小时超时时间更早地开始使机器失效。此值是一个整数，表示分钟。 示例：值为 | 是 |
| disable_percentage | <disable_percentage> 参数与 <disable_timeout> 结合使用，以便比默认的 4 小时超时时间更早地开始使机器失效。此值是一个介于 0.00 和 100.00 之间的十进制值。 示例：使用 | 是 |
响应字段
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| imageversionid | 整数 | 镜像的 ID | 否 |
| jobcreated | 整数 | 作业创建时的 Unix 时间戳 | 否 |
| joberror | 字符串 | 指示作业错误的消息 | 是 |
| jobeta | 整数 | 表示作业预计完成时间的 Unix 时间戳 | 是 |
| jobfailed | 整数 | 指示作业是否失败的数字标志 | 否 |
| jobprogress | 整数 | 指示作业进度的 0 到 100 之间的百分比 | 否 |
| jobstart | 字符串 | 作业开始时的 Unix 时间戳 | 是 |
| jobstateid | 整数 | 指示作业状态的作业状态 ID | 是 |
| jobstatename | 字符串 | 作业状态的名称 | 否 |
| jobupdated | 整数 | 作业最后更新时的 Unix 时间戳 | 否 |
| success | 布尔值 | 指示此请求是否成功的标志 | 否 |
示例请求
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imageversion/create?diffid=<diff_id>&restart=<restart>&accountserviceid=<accountserviceid>&install_at=<timestamp>&full=<full>&game_build=<game_build>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'示例响应
{
"imageversionid": <imageversionid>,
"jobcreated": <jobcreated>,
"joberror": <joberror>,
"jobeta": <jobeta>,
"jobfailed": <jobfailed>,
"jobprogress": <jobprogress>,
"jobstart": <jobstart>,
"jobstateid": <jobstateid>,
"jobstatename": <jobstatename>,
"jobupdated": <jobupdated>
}