查询伴随程序列表--云游戏-火山引擎

文档中心

立即注册

导航

查询伴随程序列表

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

本接口支持查询当前账号下已创建的伴随程序信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListFrameworkApp`	接口名称。当前 API 的名称为 `ListFrameworkApp`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
FrameworkAppId	String	否	`734358***18808617`	伴随程序 ID，缺省情况下查询所有伴随程序。
FrameworkAppName	String	否	`com.demo.profile.testdemo`	伴随程序名称，缺省情况下查询所有伴随程序。
PackageName	String	否	`A.test`	伴随程序包名，缺省情况下查询所有伴随程序。
Offset	Long	否	`0`	分页偏移量，默认值为 0。
Count	Long	否	`10`	单页数量，默认值为 10。

返回参数

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

参数	类型	示例值	描述
Total	Long	`1`	查询到的伴随程序总数
Row	Array of Row	`-`	伴随程序信息列表

Row

参数	类型	示例值	描述
FrameworkAppId	String	`89273619**092810900`	伴随程序 ID
FrameworkAppName	String	`com.demo.profile.testdemo`	伴随程序名称
FrameworkAppStart	Integer	`2`	伴随程序启动时机： `1`：在游戏开始前启动 `2`：在游戏开始后启动
PackageName	String	`A.test`	伴随程序包名
CurrentVersion	String	`0`	伴随程序当前版本 ID
Status	Integer	`1`	伴随程序状态： `1`：上架完成 `2`：首次适配中 `3`：新版本适配中 `4`：上架失败
CreateAt	Long	`1707388400`	伴随程序创建时间
UpdateAt	Long	`1707388400`	伴随程序最近更新时间

请求示例

GET https://open.volcengineapi.com?Action=ListFrameworkApp&Version=2023-03-18&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListFrameworkApp",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Row": [
            {
                "UpdateAt": 1707388400,
                "CreateAt": 1707388400,
                "Status": 1,
                "CurrentVersion": "0",
                "PackageName": "A.test",
                "FrameworkAppStart": 2,
                "FrameworkAppName": "com.demo.profile.testdemo",
                "FrameworkAppId": "89273619**092810900"
            }
        ]
    }
}

错误码

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