【旧版】查询应用信息列表 ListApp--云手机-火山引擎

文档中心

立即注册

导航

【旧版】查询应用信息列表 ListApp

最近更新时间：2025.07.25 16:02:22首次发布时间：2024.03.19 16:49:47

此接口用于查询业务下的应用列表信息。

使用说明

该接口即将废弃，请使用 2025 版本 ListApp 代替。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListApp&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListApp`	接口名称。当前 API 的名称为 `ListApp`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
AppId	String	否	`7295222843434xxxxxx`	筛选条件，应用 ID。
AppName	String	否	`test`	筛选条件，应用名称。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
AppType	Integer	否	`2`	应用类型： `0`：其他 `1`：视频 `2`：游戏 `3`：效率 `4`：办公

返回参数

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

参数	类型	示例值	描述
Row	Array of App	`-`	查询到的业务应用列表。
Total	Long	`1`	查询结果总数。

App

参数	类型	示例值	描述
AppId	String	`1641133322660xxxxxx`	应用全局唯一 ID，标识本业务的应用。
AppDesc	String	`视频应用`	应用描述。
AppName	String	`test`	应用名称。
AppType	Integer	`0`	应用类型： `0`：其他 `1`：视频 `2`：游戏 `3`：效率 `4`：办公
IconUrl	String	`http://file.bytetos.com/xxx/xxx.jpeg`	应用图标地址。
ApplyNum	Long	`3`	应用部署数量。
ReadyNum	Long	`1237`	应用安装就绪数量。
Rotation	Integer	`270`	应用横竖屏设置： `0`：0 度 `90`：90 度 `180`：180 度 `270`：270 度 `-1`：跟随系统
AppStatus	Integer	`1`	应用上下架状态： 1：上架 2：下架
ProductId	String	`1641133322660xxxxxx`	业务 ID。
PackageName	String	`com.abc.things`	应用包名。
DeployStatus	Integer	`3`	应用部署状态： `1`：未上架 `2`：上架中 `3`：已上架
LatestVersion	Object of AppVersion	`-`	应用最新的版本信息。
DeployVersionNum	Long	`3`	应用部署的版本数量。
AppMode	String	`Private`	应用生效范围： `Public`：多业务的共享应用； `Private`：单一业务的非共享应用。

AppVersion

参数	类型	示例值	描述
MD5	String	`4596ba720b59fcba9f80fcxxxxxxxxxx`	应用安装包 MD5。
AppId	String	`7295222843434xxxxxx`	应用全局唯一 ID，标识本业务的应用。
VersionId	String	`7296775317124xxxxxx`	版本 ID。
DownloadUrl	String	`https://xxx.tos.com/com.abc.apk`	应用安装包下载地址，有效期为 1 天。
PackageName	String	`com.abc.things`	应用包名。说明当应用类型为安卓 apk 时，此字段为包名；其他类型根据需求自定义。
VersionCode	Long	`2070002`	应用版本号，仅作为标识。
VersionName	String	`2.7.0`	应用版本名称。
AppVersionDesc	String	`小游戏`	应用版本描述。

请求示例

GET https://open.volcengineapi.com?Action=ListApp&Version=2023-10-30&ProductId=1591495366954xxxxxx&AppId=7295222843434xxxxxx&AppName=test&Offset=0&Count=10&AppType=2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListApp",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Row": [
            {
                "VersionList": [
                    {
                        "DownloadUrl": "https://images.tos-cn-beijing.volces.com/com.abc.apk",
                        "PackageName": "com.abc.things",
                        "VersionCode": 2070002,
                        "VersionName": "2.7.0",
                        "VersionId": 7296775317124xxxxxx,
                        "AppVersionDesc": "小游戏",
                        "AppId": "7296775317124xxxxxx",
                        "MD5": "4596ba720b59fcba9f80fcxxxxxxxxxx"
                    }
                ],
                "Rotation": 270,
                "AppDesc": "视频应用",
                "ReadyNum": 1237,
                "AppId": "7295222843434xxxxxx",
                "IconUrl": "http://file.bytetos.com/game/xxx.jpeg",
                "AppStatus": 1,
                "PackageName": "com.abc.things",
                "ApplyNum": 3,
                "DeployStatus": 3,
                "AppName": "abc",
                "DeployVersionNum": 3,
                "ProductId": "1641133322660xxxxxx",
                "AppMode": "Private",
                "LatestVersion": {
                    "PackageName": "com.abc.things",
                    "MD5": "4596ba720b59fcba9f80fcxxxxxxxxxx",
                    "VersionCode": 2070002,
                    "VersionId": 7296775317124xxxxxx,
                    "AppId": "7295222843434xxxxxx",
                    "DownloadUrl": "https://images.tos-cn-beijing.volces.com/com.abc.apk",
                    "VersionName": "2.7.0",
                    "AppVersionDesc": "小游戏"
                },
                "AppType": 0
            }
        ]
    }
}

错误码

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