创建部署策略--云游戏-火山引擎

文档中心

立即注册

导航

创建部署策略

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

本接口支持为指定游戏配置其使用的实例套餐。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1493570375567xxxxxx`	业务 ID，可在「云游戏控制台-云游戏手游-业务管理」中获取。
GameId	String	否	`7064461037747xxxxxx`	游戏 ID，可通过调用 ListGame 接口获取返回的游戏 ID。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。
CustomGameId	String	否	`id1`	用户自定义游戏 ID。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。
StrategyList	Array of DeployStrategy	是	`-`	部署策略列表

DeployStrategy

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ConfigurationCode	String	是	`ARMSoC_General`	通过火山引擎控制台已订购的实例套餐 ID，可选枚举值包括： ARMSoC_Standard（基础型） ARMSoC_General（通用型） ARMSoC_Enhanced（加强型） ARMSoC_Advanced（旗舰型）
Priority	Integer	是	`1`	实例套餐优先级（1<=数值<=套餐数量；例如业务已订购3个套餐，优先级数值就是1、2、3；数值越小优先级越高，不同套餐的优先级不能设置为相同数值）

ConfigurationCode

String

是

ARMSoC_General

通过火山引擎控制台已订购的实例套餐 ID，可选枚举值包括：

ARMSoC_Standard（基础型）
ARMSoC_General（通用型）
ARMSoC_Enhanced（加强型）
ARMSoC_Advanced（旗舰型）

Priority Integer 是 1 实例套餐优先级（1<=数值<=套餐数量；例如业务已订购3个套餐，优先级数值就是1、2、3；数值越小优先级越高，不同套餐的优先级不能设置为相同数值）

返回参数

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

参数	类型	示例值	描述
Result	String	`success`	部署策略创建成功，返回 `success`。否则返回错误。

请求示例

POST https://open.volcengineapi.com?Action=CreateDeployStrategy&Version=2023-03-18
{
    "ProductId": "1493570375567xxxxxx",
    "GameId": "7064461037747xxxxxx",
    "ConfigurationCode": "ARMSoC_General",
    "StrategyList": [
        {
            "ConfigurationCode": "ARMSoC_General",
            "Priority": 1
        }
    ]
}

返回示例

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

错误码

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