查询部署策略列表--云游戏-火山引擎

文档中心

立即注册

导航

查询部署策略列表

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

本接口支持查询指定游戏的实例套餐配置信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListDeployStrategy`	接口名称。当前 API 的名称为 `ListDeployStrategy`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	是	`1493071161301xxxxxx`	业务 ID，您可在「云游戏控制台-云游戏手游-业务管理」中获取。
GameId	String	否	`7064470096059xxxxxx`	游戏 ID，可通过调用 ListGame 接口获取。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。
CustomGameId	String	否	`id1`	游戏标识，可通过调用 ListGame 接口获取。`GameId` 和 `CustomGameId` 二选一，同时指定时 `GameId` 优先。

返回参数

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

参数	类型	示例值	描述
GameId	String	`7064470096059xxxxxx`	游戏 ID
ConfigurationCode	String	`ARMSoC_General`	实例套餐 ID： ARMSoC_Standard ARMSoC_General ARMSoC_Enhanced ARMSoC_Advanced
ConfigurationName	String	`通用型`	实例套餐名称：基础型通用型加强型旗舰型
Priority	Integer	`1`	实例套餐优先级，数值越小优先级越高

请求示例

GET https://open.volcengineapi.com?Action=ListDeployStrategy&Version=2023-03-18&ProductId=1493071161301xxxxxx&GameId =7064470096059xxxxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "ListDeployStrategy",
        "Region": "cn-north-1",
        "RequestId": "2022080511404001017424420909D56534",
        "Service": "veGame",
        "Version": "2023-03-18"
    },
    "Result": [
        {
            "ConfigurationCode": "ARMSoC_General",
            "priority": 1,
            "ConfigurationName": "通用型",
            "GameId": "7083458862677957420"
        },
        {
            "Configuration_code": "ARMSoC_Enhanced",
            "priority": 2,
            "configurationName": "加强型",
            "GameId": "7083458862677957420"
        }
    ]
}

错误码

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