tencent cloud

数据万象

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
应用场景
功能概览
地域与域名
使用限制
产品计费
计费概述
计费方式
计费项
免费额度
欠费说明
查看消费明细
常见问题
快速入门
注册与登录
绑定存储桶
上传和处理文件
下载和删除文件
解绑存储桶
通过 COS 使用数据万象
能力地图
图片处理
媒体处理
内容审核
AI 内容识别
文档处理
智能语音
文件处理
用户指南
概览
存储桶管理
智能工具箱
任务与工作流
数据监控
用量统计
实践教程
版权保护解决方案
图片处理实践
API 授权策略使用指引
工作流实践
API 文档
API 概览
结构体
公共请求头部
公共响应头部
开通万象服务
图片处理
AI 内容识别
智能语音
媒体处理
内容审核
文档处理
文件处理
任务与工作流
云查毒
错误码
请求签名
SDK 文档
SDK 概览
图片处理 Android SDK
图片处理 iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
小程序 SDK
SDK 产品个人信息保护规则
安全与合规
权限管理
常见问题
基础设置
文档处理
媒体处理
内容识别
智能语音
服务协议
Service Level Agreement
联系我们
词汇表
文档数据万象SDK 文档PHP SDK文件处理文件哈希值计算

文件哈希值计算

PDF
聚焦模式
字号
最后更新时间： 2024-03-13 10:25:33

简介

本文档提供关于文件哈希值计算接口的 API 概览和 SDK 示例代码。

API
操作描述
以同步请求的方式进行文件哈希值计算，实时返回计算得到的哈希值，该接口属于 GET 请求。
以提交任务的方式进行文件哈希值计算，异步返回计算得到的哈希值，该接口属于 POST 请求。
本接口用于主动查询指定的文件哈希值计算任务结果。

哈希值计算同步请求

功能说明

以同步请求的方式进行文件哈希值计算，实时返回计算得到的哈希值，该接口属于 GET 请求。

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // https://www.tencentcloud.com/document/product/436/53990 哈希值计算同步请求
    $result = $cosClient->FileJobs4Hash(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.tencentcloud.com/cos5/bucket
        'Key' => 'for-test.mp4', // 桶文件
        'Type' => 'md5', // 支持的哈希算法类型，有效值：md5、sha1、sha256
//        'AddToHeader' => 'true', // 是否将计算得到的哈希值，自动添加至文件的自定义 header，格式为：x-cos-meta-md5/sha1/sha256; 有效值： true、false，不填则默认为 false。
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
    /**
     * 可能出现的 Exception
     * 1. Error Message: file processing is not active yet, please apply for file processing service first
     *    解决方式：开通文件处理服务
     */
}

参数说明

Request 中的具体数据描述如下：
参数名称
类型
描述
是否必填
Bucket
String
存储桶名称，格式：BucketName-APPID
是
Key
String
桶文件
是
Type
String
支持的哈希算法类型，有效值：md5、sha1、sha256
是
AddToHeader
String
是否将计算得到的哈希值，自动添加至文件的自定义 header，格式为：x-cos-meta-md5/sha1/sha256; 有效值： true、false，不填则默认为 false。
否

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjNkOGM2NmVfZTYxNmY5MSAASJPOJCIANSIDNAI
    [ContentType] => application/xml
    [ContentLength] => 421
    [FileHashCodeResult] => Array
        (
            [Etag] => "1f3ede740849eaa2e79e9b269ea3db2a"
            [LastModified] => 2023-01-29T11:31:02+0000
            [MD5] => 1f3ede740849eaa2e79e9b269ea3db2a
            [FileSize] => 42120
        )

    [Input] => Array
        (
            [Region] => ap-guangzhou
            [Bucket] => examplebucket-1250000000
            [Object] => sound01.mp3
        )

    [Key] => sound01.mp3
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/sound01.mp3
)

提交哈希值计算任务

功能说明

以提交任务的方式进行文件哈希值计算，异步返回计算得到的哈希值，该接口属于 POST 请求。

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // https://www.tencentcloud.com/document/product/436/53991 提交哈希值计算任务-异步
    $result = $cosClient->createFileHashCodeJobs(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.tencentcloud.com/cos5/bucket
        'Tag' => 'FileHashCode',
//        'QueueId' => 'pcc3ae89sa9d807fs89dg789sdg',
        'Input' => array(
            'Object' => 'test.mp4',
        ),
        'Operation' => array(
            'UserData' => 'xxx',
            'FileHashCodeConfig' => array(
                'Type' => 'MD5',
                'AddToHeader' => 'true',
            ),
        ),
//        'CallBackFormat' => '',
//        'CallBackType' => '',
//        'CallBack' => '',
//        'CallBackMqConfig' => array(
//            'MqRegion' => '',
//            'MqMode' => '',
//            'MqName' => '',
//        ),
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
表示任务的类型，哈希值计算默认为：FileHashCode。
String
是
Input
Request
包含待操作的文件信息。
Container
是
Operation
Request
包含哈希值计算的处理规则。
Container
是
QueueId
Request
任务所在的队列 ID。
String
是
CallBackFormat
Request
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式。
String
否
CallBackType
Request
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型。
String
否
CallBack
Request
任务回调的地址，优先级高于队列的回调地址。
String
否
CallBackMqConfig
Request
任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig
Container
否
Container 类型 Input 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Object
Request.Input
文件名，取值为文件在当前存储桶中的完整名称。
String
是
Container 类型 Operation 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
FileHashCodeConfig
Request.Operation
指定哈希值计算的处理规则。
Container
是
UserData
Request.Operation
透传用户信息, 可打印的 ASCII 码, 长度不超过1024
String
否
Container 类型 FileHashCodeConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Type
Request.Operation.FileHashCodeConfig
哈希值的算法类型，有效值：MD5、SHA1、SHA256。
String
是
AddToHeader
Request.Operation.FileHashCodeConfig
是否将计算得到的哈希值添加至文件自定义header, 有效值：true、false，默认值为 false。 自定义header根据Type的值变化，例如Type值为MD5时，自定义header为 x-cos-meta-md5。
String
否

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjNkOGM2NmVfZTYxNmY5MSAASJPOJCIANSIDNAI=
    [ContentType] => application/xml
    [ContentLength] => 738
    [JobsDetail] => Array
        (
            [Progress] => 0
            [Code] => Success
            [Message] => 
            [JobId] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
            [Tag] => FileHashCode
            [State] => Submitted
            [CreationTime] => 2023-01-31T15:49:33+0800
            [StartTime] => -
            [EndTime] => -
            [QueueId] => pcc3ae89sa9d807fs89dg789sdg
            [Input] => Array
                (
                    [BucketId] => examplebucket-1250000000
                    [Region] => ap-guangzhou
                    [Object] => sound01.mp3
                )

            [Operation] => Array
                (
                    [JobLevel] => 0
                    [UserData] => xxx
                    [FileHashCodeConfig] => Array
                        (
                            [Type] => MD5
                            [AddToHeader] => true
                        )

                )

        )

    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/file_jobs
)

查询哈希值计算结果

功能说明

本接口用于主动查询指定的文件哈希值计算任务结果。

方法原型

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

请求示例

<?php

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

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部，默认为http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    // https://www.tencentcloud.com/document/product/436/53992 查询哈希值计算结果
    $result = $cosClient->getFileHashCodeResult(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由 BucketName-Appid 组成，可以在 COS 控制台查看 https://console.tencentcloud.com/cos5/bucket
        'Key' => '', // jobId
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
参数名称
类型
描述
是否必填
Bucket
String
存储桶名称，格式：BucketName-APPID
是
Key
String
jobId
是

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjNkOGM2NmVfZTYxNmY5MSAASJPOJCIANSIDNAI=
    [ContentType] => application/xml
    [ContentLength] => 1048
    [JobsDetail] => Array
        (
            [Progress] => 100
            [Code] => Success
            [Message] => success
            [JobId] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
            [Tag] => FileHashCode
            [State] => Success
            [CreationTime] => 2023-01-31T15:49:33+0800
            [StartTime] => 2023-01-31T15:49:33+0800
            [EndTime] => 2023-01-31T15:49:34+0800
            [QueueId] => pcc3ae89sa9d807fs89dg789sdg
            [Input] => Array
                (
                    [BucketId] => examplebucket-1250000000
                    [Region] => ap-guangzhou
                    [Object] => sound01.mp3
                )

            [Operation] => Array
                (
                    [JobLevel] => 0
                    [UserData] => xxx
                    [FileHashCodeConfig] => Array
                        (
                            [Type] => MD5
                            [AddToHeader] => true
                        )

                    [FileHashCodeResult] => Array
                        (
                            [MD5] => 1f3ede740849eaa2e79e9b269ea3db2a
                            [LastModified] => 2023-01-29T11:31:02+0000
                            [Etag] => "1f3ede740849eaa2e79e9b269ea3db2a"
                            [FileSize] => 42120
                        )

                )

        )

    [Key] => fcd32dbdaa13b11esa9ds8g0d98gd0h85
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/file_jobs/fcd32dbdaa13b11esa9ds8g0d98gd0h85
)

上一篇: 多文件打包压缩下一篇: 文件解压

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈