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

文档中心

立即注册

导航

查询应用信息列表 ListApp

最近更新时间：2025.07.25 15:42:59首次发布时间：2025.07.25 15:42:59

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

注意事项

本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListApp&Version=2025-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListApp`	接口名称。当前 API 的名称为 `ListApp`。
Version	String	是	`2025-05-01`	接口版本。当前 API 的版本为 `2025-05-01`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
AppId	String	否	`7295222843434xxxxxx`	筛选条件，应用 ID。
AppName	String	否	`test`	筛选条件，应用名称。
AppType	Integer	否	`2`	筛选条件，应用类型。 0：其他 1：视频 2：游戏 3：效率 4：办公
PackageNameList	Array of String	否	`["com.test.app"]`	筛选条件，应用包名列表。参数使用说明：可在云手机控制台 > 应用管理 > 版本管理中获取应用的包名。可传入至多 10 个应用包名，多个包名之间使用半角逗号（,）间隔。例如：`["com.test.app", "com.example.app"]` 如果传入的应用包名不存在，对应返回的信息为空值。
MaxResults	Integer	否	`10`	分页大小。最大值：100 默认值：10
NextToken	String	否	`wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k`	分页查询凭证，用于标记查询数据的起始位置。初次查询时无需设置，服务器将根据筛选条件返回一部分数据，并返回一个 NextToken 凭证值记录这批数据的结尾位置，作为下次查询的起始位置。后续查询中，将上一次查询时返回的 NextToken 作为参数传入，服务器会从该位置继续返回后续数据。注意重复调用本接口进行接续查询时，不可修改原始筛选条件，否则会影响查询数据的连贯性和准确性。如需修改筛选条件，请将本参数置空，从第一条数据开始重新查询。接口返回的 NextToken 有效期为 2 小时，若传入过期或无效的值，服务器将从第一条数据开始重新查询并返回。

返回参数

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

参数	类型	示例值	描述
NextToken	String	`wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k`	本次调用返回的查询凭证，若返回空置即表示该页为末页。注意 NextToken 有效期为 2 小时，若下次请求时使用了过期凭证，则将从第一条数据开始重新查询。
Row	Array of App	`-`	查询到的业务应用列表。

App

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

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.test.app`	应用包名。说明当应用类型为安卓 apk 时，此字段为包名；其他类型根据需求自定义。
VersionCode	Long	`2070002`	应用版本号，仅作为标识。
VersionName	String	`2.7.0`	应用版本名称。
AppVersionDesc	String	`小游戏`	应用版本描述。

请求示例

POST https://open.volcengineapi.com?Action=ListApp&Version=2025-05-01
{
    "ProductId": "1749281594201xxxxxx",
    "AppId": "7295222843434xxxxxx",
    "AppName": "test",
    "AppType": 2,
    "PackageNameList": [
        "com.test.app"
    ],
    "MaxResults": 10,
    "NextToken": "wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListApp",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "NextToken": "wyc87CUcfU1pIlpAinyljWVCLc0mqRLetP99DZs-v3yv4x5DRq9FGdWtT**********xlc8mJ1VRIATB_Dv1Tcn0YJdiq1k9XzjGDLArAgX6g3CzaFNGy7gUqkOb2U-k",
        "Row": [
            {
                "AppId": "1641133322660xxxxxx",
                "AppDesc": "视频应用",
                "AppMode": "Private",
                "AppName": "test",
                "AppType": 2,
                "IconUrl": "http://file.bytetos.com/xxx/xxx.jpeg",
                "ApplyNum": 3,
                "ReadyNum": 1237,
                "Rotation": 270,
                "AppStatus": 1,
                "ProductId": "1641133322660xxxxxx",
                "PackageName": "com.test.app",
                "VersionList": [],
                "DeployStatus": 3,
                "LatestVersion": {
                    "MD5": "4596ba720b59fcba9f80fcxxxxxxxxxx",
                    "AppId": "7295222843434xxxxxx",
                    "VersionId": "7296775317124xxxxxx",
                    "DownloadUrl": "https://xxx.tos.com/com.abc.apk",
                    "PackageName": "com.test.app",
                    "VersionCode": 2070002,
                    "VersionName": "2.7.0",
                    "AppVersionDesc": "小游戏"
                },
                "DeployVersionNum": 3
            }
        ]
    }
}

错误码

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