You need to enable JavaScript to run this app.
导航
更新部署策略
最近更新时间:2025.01.20 15:42:48首次发布时间:2022.03.03 11:01:25

更新指定游戏的实例套餐配置。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称UpdateDeployStrategy
VersionQueryString公共参数,OpenAPI 接口版本2022-02-10

Body 参数

字段
类型
必填
说明
product_idString业务ID,可在「云游戏控制台-业务管理」中获取

game_id

String

游戏 ID,可通过调用 ListGame 接口获取

当传入 custom_game_id 时,可不传入(以 game_id 优先)

custom_game_id

String

用户自定义游戏 ID,可通过调用 ListGame 接口获取

当传入 game_id 时,可不传入

strategy_listList<DeployStrategy>部署策略列表,参考以下 DeployStrategy 结构说明

DeployStrategy 结构说明

字段
类型
必填
说明

configuration_code

String

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

  • ARMSoC_Standard(基础型)
  • ARMSoC_General(通用型)
  • ARMSoC_Enhanced(加强型)
  • ARMSoC_Advanced(旗舰型)
priorityInt8实例套餐优先级(1<=数值<=套餐数量;例如业务已订购3个套餐,优先级数值就是1、2、3;数值越小优先级越高,不同套餐的优先级不能设置为相同数值)

返回结果

通用返回参数,参考 ResponseMetadata 结构说明

字段
类型
说明
ResultString部署策略更新成功,返回 success

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateDeployStrategy
&Version=2022-02-10
&<通过header传入的公共请求参数>

{
    "product_id": "1493570375567xxxxxx",
    "game_id": "7064461037747xxxxxx",
    "strategy_list": [
        {
        "configuration_code": "ARMSoC_General",
        "priority": 1
        },
        {
        "configuration_code": "ARMSoC_Enhanced",
        "priority": 2
        },
        {
        "configuration_code": "ARMSoC_Advanced",
        "priority": 3
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateDeployStrategy",
        "Region": "cn-north-1",
        "RequestId": "20220216161406010225133143072A3CAC",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}