文档中心 > API类目 > 聚安全API

alibaba.security.jaq.app.risk.scan (应用风险扫描提交接口)

提交应用进行风险扫描(含漏洞扫描、恶意代码检测、仿冒监测),扫描完成后可通过对应的查询接口查询扫描结果

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
app_info ScanAppInfo 可选 应用信息
  • └ app_os_type
  • Number
  • 可选
  • 1
  • app 类型,1-apk, 2-ipa(暂不支持)
  • └ callback_url
  • String
  • 可选
  • http://aaa.com/callback
  • 任务处理完成后的反向通知回调地址,请不要使用ip地址,可能会无法回调,dataType=1时必填,通知为GET请求,请求URL: callbackUrl+"?item_id=xxx&task_status=1"; item_id为应用加固/风险扫描接口返回的任务ID; task_status为任务状态: 1-已完成,2-处理中,3-处理出错,4-处理超时; 对于应用加固,接收到通知后如果task_status为1则可通过对应的查询接口查询加固/扫描结果; 对于应用风险扫描,如果task_status为1,3,4均可通过对应查询接口查询到结果,但不包括失败的扫描项的结果
  • └ data
  • String
  • 可选
  • http://xsx.com/123412.apk
  • APP数据 dataType=1时填写 App包的下载地址; dataType=2时填写 App包的md5值
  • └ data_type
  • Number
  • 可选
  • 1
  • APP数据类型 1-App URL 2-App MD5,应用加固仅支持1,风险扫描支持1和2
  • └ md5
  • String
  • 可选
  • dd5b29a800246d7089febf228286d901
  • APP包的MD5值,dataType=1时必填,用于文件校验
  • └ size
  • Number
  • 可选
  • 21341
  • APP包大小(单位:字节),dataType=1时必填,用于文件校验
scan_types String [] 可选 vuln,malware,fake
  • 最大列表长度:20
  • 扫描类型:vuln-漏洞扫描 malware-恶意代码检测 fake-仿冒监测 plugin-插件扫描 注: dataType为2时 不支持 仿冒监测
    ext_param String 可选 test 额外的信息,根据具体业务定

    响应参数

    名称 类型 示例值 描述
    result TaskInfo 扫描任务信息
    • └ item_id
    • String
    • 0217beb9-87ac-4d01-ae37-a51448a261ff
    • 任务唯一标识
    • └ progress
    • Number
    • 1
    • 任务处理进度: 1-处理完成 (可立即通过对应的查询接口查询处理结果), 2-异步处理中(需等待app_info.callback_url接收到反向通知后再查询结果) ; 对于app_info.data_type为1目前都是异步处理,此字段返回2; 对于app_info.data_type为2目前都是同步处理,此字段返回1

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaSecurityJaqAppRiskScanRequest req = new AlibabaSecurityJaqAppRiskScanRequest();
    AlibabaSecurityJaqAppRiskScanRequest.ScanAppInfo obj1 = new AlibabaSecurityJaqAppRiskScanRequest.ScanAppInfo();
    obj1.setAppOsType(1L);
    obj1.setCallbackUrl("http://aaa.com/callback");
    obj1.setData("http://xsx.com/123412.apk");
    obj1.setDataType(1L);
    obj1.setMd5("dd5b29a800246d7089febf228286d901");
    obj1.setSize(21341L);
    req.setAppInfo(obj1);
    req.setScanTypes("vuln,malware,fake");
    req.setExtParam("test");
    AlibabaSecurityJaqAppRiskScanResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_security_jaq_app_risk_scan_response>
        <result>
            <item_id>0217beb9-87ac-4d01-ae37-a51448a261ff</item_id>
            <progress>1</progress>
        </result>
    </alibaba_security_jaq_app_risk_scan_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isv.param-error 请求参数错误 请检查输入参数
    isp.server-error 服务端错误 服务端处理错误,请稍后进行重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部