查询应用信息 DetailApp--云手机-火山引擎

文档中心

立即注册

导航

查询应用信息 DetailApp

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

此接口用于查询指定应用的详情及应用版本信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DetailApp`	接口名称。当前 API 的名称为 `DetailApp`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
AppId	String	是	`7291189096629xxxxxx`	应用 ID，可通过调用 ListApp 接口获取。

返回参数

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

参数	类型	示例值	描述
ProductId	String	`1641133322660xxxxxx`	业务 ID
AppId	String	`7651133322660xxxxxx`	应用全局唯一 ID，标识本业务的应用
AppName	String	`test`	应用名称
PackageName	String	`com.abc.things`	应用包名
AppType	Integer	`0`	应用类型： `0`：其他 `1`：视频 `2`：游戏 `3`：效率 `4`：办公
Rotation	Integer	`0`	横竖屏设置： `0`：0 度 `90`：90 度 `180`：180 度 `270`：270 度 `-1`：跟随系统
IconUrl	String	`http://file.bytetos.com/game/xxx.jpeg`	应用图标地址
AppDesc	String	`视频应用`	应用描述
AppStatus	Integer	`1`	应用上下架： 1 => 上架 2 => 下架
DeployStatus	Integer	`3`	应用部署状态： `1`：未上架 `2`：上架中 `3`：已上架
ReadyNum	Long	`3`	应用安装就绪数量
ApplyNum	Long	`4`	应用部署数量
DeployVersionNum	Long	`3`	应用部署的版本数量
LatestVersion	Object of AppVersion	`-`	应用最新的版本信息，参看 AppVersion 数据结构说明。
VersionList	Array of AppVersion	`-`	应用版本列表，参看 AppVersion 数据结构说明。
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=DetailApp&Version=2023-10-30&ProductId=1591495366954xxxxxx&AppId=7291189096629xxxxxx

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104******100232280022D31",
        "Action": "DetailApp",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "ReadyNum": 1,
        "IconUrl": "http://file.bytetos.com/game/xxx.jpeg",
        "DeployVersionNum": 2,
        "ApplyNum": 2,
        "ProductId": "1641133322660xxxxxx",
        "VersionList": [
            {
                "VersionId": "7291191724310xxxxxx",
                "VersionName": "15.0.1",
                "PackageName": "com.game.abc",
                "VersionCode": 1501,
                "AppId": "7291189096629xxxxxx",
                "AppVersionDesc": "",
                "MD5": "19a64f7bdb66f9d5af3bb4xxxxxxxxxx",
                "DownloadUrl": "https://images.tos-cn-beijing.volces.com/com.abc1.apk"
            }
        ],
        "PackageName": "com.game.abc",
        "AppStatus": 1,
        "LatestVersion": {
            "AppVersionDesc": "",
            "DownloadUrl": "https://images.tos-cn-beijing.volces.com/com.abc.apk",
            "PackageName": "com.game.abc",
            "VersionId": "7291191724310xxxxxx",
            "AppId": "729118909662xxxxxx",
            "VersionName": "15.0.1",
            "VersionCode": 15,
            "MD5": "19a64f7bdb66f9d5af3bb4xxxxxxxxxx"
        },
        "DeployStatus": 3,
        "Rotation": 270,
        "AppDesc": "小游戏应用",
        "AppId": "1641133322660xxxxxx",
        "AppType": 0,
        "AppName": "球球游戏",
        "AppMode": "Private"
    }
}

错误码

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