控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

简介

本文档提供关于云查毒接口的 API 概览和 SDK 示例代码。

注意:

需要 COS PHP SDK v2.5.0 及以上版本。旧版本可能存在 bug,使用时建议升级到 最新版本

API 操作描述
提交病毒检测任务 用于提交一个病毒检测任务
查询病毒检测任务结果 用于查询一个病毒检测任务的状态或结果

提交病毒检测任务

功能说明

用于提交一个病毒检测任务。

方法原型

public Guzzle\Service\Resource\Model detectVirus(array $args = array());

请求示例

示例一:存储桶文件查毒

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    // 存储桶文件查毒
    $result = $cosClient->detectVirus(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Input' => array(
            'Object' => 'test01.exe'
        ),
        'Conf' => array(
            'DetectType' => 'Virus',
//          'Callback' => '',
        ),
    ));
    // 请求成功
    print_r($result);
}  catch (\Exception $e) {
    // 请求失败
    echo($e);
}

示例二:URL查毒

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    // URL查毒
    $result = $cosClient->detectVirus(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Input' => array(
            'Url' => 'https://example.com/test01.exe',
        ),
        'Conf' => array(
            'DetectType' => 'Virus',
//            'Callback' => '',
        ),
    ));
    // 请求成功
    print_r($result);
}  catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下:

参数名称 类型 描述 是否必填
Bucket String 存储桶名称,格式:BucketName-APPID
Conf Array 操作规则
Input Array 需要检测的文件信息

Conf 中的具体数据描述如下:

参数名称 类型 描述 是否必填
DetectType String 检测的病毒类型,当前固定为:Virus
Callback String 回调地址,以http://或者https://开头的地址

查询病毒检测任务结果

功能说明

用于查询一个病毒检测任务的状态或结果。

方法原型

public Guzzle\Service\Resource\Model getDetectVirusResult(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', // 审核时必须为https
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    $result = $cosClient->getDetectVirusResult(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => 'examplejobid', // JobId
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

参数名称 类型 描述 是否必填
Bucket String 存储桶名称,格式:BucketName-APPID
Key String 需要查询的任务 ID
目录