文件哈希值计算

最近更新时间:2024-07-26 11:33:42

我的收藏

简介

本文档提供关于数据万象文件哈希值计算的 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.1。
API
操作描述
创建一个文件处理哈希值计算任务
查询一个文件处理哈希值计算结果任务
同步计算文件哈希值

提交哈希值计算任务

功能说明

以提交任务的方式进行文件哈希值计算,异步返回计算得到的哈希值。

示例代码

function postFileHashTask() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_jobs';
var url = 'https://' + host;
var body = COS.util.json2xml({
Request: {
Tag: 'FileHashCode', // 必须
Input: {
Object: 'test/1.pdf', // 文件名,取值为文件在当前存储桶中的完整名称
},
Operation: {
FileHashCodeConfig: {
Type: 'MD5', // 哈希值的算法类型,有效值:MD5、SHA1、SHA256
AddToHeader: 'false', // 是否将计算得到的哈希值添加至文件自定义header, 有效值:true、false,默认值为 false。
},
// UserData: '', // 透传用户信息, 可打印的 ASCII 码, 长度不超过1024
},
// CallBack: 'http://callback.demo.com', // 任务回调的地址
// CallBackFormat: 'JSON', // 任务回调格式
// CallBackType: 'Url', // 任务回调类型,Url 或 TDMQ,默认 Url
}
});
cos.request({
Method: 'POST',
Key: 'file_jobs',
Url: url,
Body: body,
ContentType: 'application/xml',
},
function(err, data){
console.log(err || data);
});
}
postFileHashTask();

参数说明

Request 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Tag
Request
表示任务的类型,哈希值计算任务类型为:FileHashCode。
String
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
Input 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Object
Request.Input
文件名,取值为文件在当前存储桶中的完整名称。
String
Operation 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
FileHashCodeConfig
Request.Operation
指定哈希值计算的处理规则。
Container
UserData
Request.Operation
透传用户信息,可打印的 ASCII 码,长度不超过1024。
String
FileHashCodeConfig 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Type
Request.Operation.FileHashCodeConfig
哈希值的算法类型,有效值:MD5、SHA1、SHA256。
String
AddToHeader
Request.Operation.FileHashCodeConfig
是否将计算得到的哈希值添加至文件自定义 header,有效值:true、false,默认值为 false。<br>自定义header根据 Type 的值变化,例如 Type 值为 MD5 时,自定义 header为 x-cos-meta-md5。
String

返回结果说明

详情请参见 提交哈希值计算任务

查询哈希值计算结果

功能说明

查询一个文件处理任务,根据任务 ID 查询任务详情。


示例代码

function getFileHashTask() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
var jobId = 'xxxxxx'; // 提交文件哈希值计算任务后会返回当前任务的 jobId
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_jobs/' + jobId;
var url = 'https://' + host;
cos.request({
Method: 'GET',
Key: 'file_jobs/' + jobId,
Url: url,
},
function(err, data){
console.log(err || data);
});
}
getFileHashTask();

参数说明

参数名称
描述
类型
是否必选
jobId
要查询的任务 ID
String

返回结果说明

详情请参见 查询哈希值计算结果

哈希值计算同步请求

功能说明

以同步请求的方式进行文件哈希值计算,实时返回计算得到的哈希值。

示例代码

function generateFileHash() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
var key = 'test.pdf';
var host = config.Bucket + '.cos.' + config.Region + '.myqcloud.com/' + key;
var url = 'https://' + host;
cos.request({
Method: 'GET',
Key: key,
Url: url,
Query: {
'ci-process': 'filehash', /* 必须,操作类型,哈希值计算固定为:filehash */
'type': 'md5', /* 必须,支持的哈希算法类型,有效值:md5、sha1、sha256 */
// 'addtoheader': false, /* 非必须,是否将计算得到的哈希值,自动添加至文件的自定义header,格式为:x-cos-meta-md5/sha1/sha256;有效值:true、false,不填则默认为false。 */
},
},
function(err, data){
logger.log(err || data);
});
}
generateFileHash();

参数说明

参数名称(关键字)
描述
类型
是否必选
ci-process
操作类型,哈希值计算固定为:filehash。
String
type
支持的哈希算法类型,有效值:md5、sha1、sha256。
String
addtoheader
是否将计算得到的哈希值,自动添加至文件的自定义 header,格式为:x-cos-meta-md5/sha1/sha256;有效值: true、false,不填则默认为 false。
String

返回结果说明

详情请参见 哈希值计算同步请求