You need to enable JavaScript to run this app.
导航
查询游戏伴随程序配置
最近更新时间:2025.01.20 15:42:49首次发布时间:2022.07.28 15:09:50

查询指定游戏已配置的伴随程序。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称ListGameFrameworkApp
VersionQueryString公共参数,OpenAPI 接口版本2022-02-10
game_idQueryString筛选条件,游戏 ID可通过调用 ListGame 接口获取
framework_app_idQueryString筛选条件,伴随程序 ID如指定此参数,则查询该伴随程序的信息;否则查询游戏已配置的所有伴随程序信息

返回结果

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

Result 字段包含以下参数:

字段
类型
说明
totalInt64查询到的伴随程序总数
rowList<AppInformation>伴随程序信息列表,参考以下 AppInformation 结构说明

AppInformation 结构说明

字段
类型
说明
framework_app_idString伴随程序 ID
framework_app_nameString伴随程序名称
framework_app_startInt8伴随程序启动时机
current_version_idString伴随程序正在使用的版本 ID
package_nameString伴随程序包名
version_codeInt32伴随程序版本号
md5String伴随程序安装文件 MD5

fw_source

Int8

伴随程序的上传来源:

  • 1(默认上传)
  • 2(客户上传)
create_atInt64伴随程序创建时间
update_atInt64伴随程序最近更新时间

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "Action": "ListGameFrameworkApp",
        "Region": "cn-north-1",
        "RequestId": "20220222120920010225110011036CB830",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "row": [
            {
                "framework_app_id": "7064470096059xxxxxx",
                "framework_app_name": "伴随程序名",
                "framework_app_start": 1,
                "current_version_id": "7064470096059xxxxxx",
                "package_name": "com.image.frameworkappname",
                "version_code": 235,
                "md5": "5403bf7211ec9fb042a6825876xxxxxx",
                "fw_source": 2,
                "create_at": 1645502043,
                "update_at": 1646502160
            }
        ],
        "total": 1
    }
}