查询指定游戏已配置的伴随程序。
使用 GET 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | ListGameFrameworkApp |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2022-02-10 |
game_id | Query | String | 是 | 筛选条件,游戏 ID | 可通过调用 ListGame 接口获取 |
framework_app_id | Query | String | 否 | 筛选条件,伴随程序 ID | 如指定此参数,则查询该伴随程序的信息;否则查询游戏已配置的所有伴随程序信息 |
通用返回参数,参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
total | Int64 | 查询到的伴随程序总数 |
row | List<AppInformation> | 伴随程序信息列表,参考以下 AppInformation 结构说明 |
AppInformation 结构说明
字段 | 类型 | 说明 |
---|---|---|
framework_app_id | String | 伴随程序 ID |
framework_app_name | String | 伴随程序名称 |
framework_app_start | Int8 | 伴随程序启动时机 |
current_version_id | String | 伴随程序正在使用的版本 ID |
package_name | String | 伴随程序包名 |
version_code | Int32 | 伴随程序版本号 |
md5 | String | 伴随程序安装文件 MD5 |
fw_source | Int8 | 伴随程序的上传来源:
|
create_at | Int64 | 伴随程序创建时间 |
update_at | Int64 | 伴随程序最近更新时间 |
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 } }