文档中心>API 中心

环境安全检测-apk检测

最近更新时间:2024-03-12 01:42:18

我的收藏

1. 接口描述

接口请求域名: ms.tencentcloudapi.com 。

该接口采用同步模式请求腾讯APK云检测服务,即时返回检测数据,需要用户用轮询的方式调用本接口来进行样本送检并获取检测结果(每隔60s发送一次请求,传相同的参数,重试30次),一般情况下0.5h内会出检测结果,最长时间是3h。当Result为ok并且ResultList数组非空有值时,代表检测完毕,若长时间获取不到检测结果,请联系客服。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApkDetectionResult。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,详见产品支持的 地域列表
ApkUrl String 软件包的下载链接
示例值:"https://xxx.xxx.xx"
ApkMd5 String 软件包的md5值,具有唯一性。腾讯APK云检测服务会根据md5值来判断该包是否为库中已收集的样本,已存在,则返回检测结果,反之,需要一定时间检测该样本。
示例值:"2751xxxxxd1d203d6621ea28a0axxxxx"

3. 输出参数

参数名称 类型 描述
Result String 响应结果,ok表示正常,error表示错误
示例值:"ok"
Reason String Result为error错误时的原因说明
示例值:""
ResultList Array of ResultListItem APK检测结果数组
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 环境安全检测-apk检测

输入示例

POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApkDetectionResult
<公共请求参数>

{
    "ApkUrl": "http://xxx.xxx",
    "ApkMd5": "2751xxxxxd1d203d6621ea28a0axxxxx"
}

输出示例

{
    "Response": {
        "Reason": "xx",
        "ResultList": [
            {
                "SafeType": "xx",
                "BoutiqueRecommand": "xx",
                "OptPluginList": [
                    {
                        "PluginDesc": "xx",
                        "PluginName": "xx",
                        "PluginType": "xx"
                    }
                ],
                "Sid": "xx",
                "VirusDesc": "xx",
                "Official": "xx",
                "Spot": "xx",
                "Errno": "xx",
                "SoftName": "xx",
                "RepackageStatus": "xx",
                "PluginList": [
                    {
                        "PluginDesc": "xx",
                        "PluginName": "xx",
                        "PluginType": "xx"
                    }
                ],
                "IntegralWall": "xx",
                "NotifyBar": "xx",
                "FloatWindows": "xx",
                "Md5": "xx",
                "Banner": "xx",
                "ErrMsg": "xx",
                "VirusName": "xx"
            }
        ],
        "RequestId": "xx",
        "Result": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError 内部错误。
InternalError.ApkServerError Apk检测服务端无法响应。
InternalError.ServerError 服务端无法响应。
InvalidParameter 参数错误。
InvalidParameter.ParameterError 参数格式错误。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation.NotWhiteUser 不是白名单用户。
UnsupportedOperation 操作不支持。