有奖:语音产品征文挑战赛等你来> HOT

简介

本文档提供关于文件处理哈希值计算异步请求的 API 概览以及 SDK 示例代码。
API
说明
用于异步文件处理哈希值计算功能

异步请求接口

功能说明

文件处理哈希值计算功能异步请求。

方法原型

def ci_create_file_hash_job(self, Bucket, InputObject,
FileHashCodeConfig, QueueId=None, CallBack=None, CallBackFormat=None,
CallBackType=None, CallBackMqConfig=None, UserData=None, **kwargs)

请求示例

def ci_create_file_hash_job():
body = {
'Type': 'MD5',
}
response = client.ci_create_file_hash_job(
Bucket=bucket_name,
InputObject="mytest.mp4",
FileHashCodeConfig=body
)
print(response)
return response

参数说明

参数名称
描述
类型
是否必选
Bucket
对象所在存储桶
String
InputObject
对象文件名,例如 folder/document.pdf
String
QueueId
任务所在的队列 ID,开通文件处理服务后自动生成,请使用 查询队列 获取或通过 万象控制台获取队列ID 在存储桶中查询
String
FileHashCodeConfig
指定哈希值计算的处理规则
dict
CallBack
任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调
string
CallBackFormat
任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式
string
CallBackType
任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型
string
CallBackMqConfig
任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填,详见 CallBackMqConfig 详情
dict
UserData
透传用户信息,可打印的 ASCII 码,长度不超过1024
String
参数 FileHashCodeConfig 详情:
参数名称
描述
类型
是否必选
Type
哈希值的算法类型,支持:MD5、SHA1、SHA256
String
AddToHeader
是否将计算得到的哈希值添加至文件自定义header,有效值:true、false,默认值为 false。自定义header根据Type的值变化,例如:Type值为MD5时,自定义header为 x-cos-meta-md5。
String

返回结果说明

{
"Response": {
"JobsDetail": {
"Code": "Success",
"Message": "",
"JobId": "f93984788066911ed89ed352d4d9d2084",
"State": "Submitted",
"CreationTime": "2022-07-18T15:16:43+0800",
"EndTime": "-",
"StartTime": "-",
"QueueId": "p2911917386e148639319e13c285cc774",
"Tag": "FileHashCode",
"Input": {
"BucketId": "test-1234567890",
"Object": "input/deer.jpg",
"Region": "ap-chongqing"
},
"Operation": {
"FileHashCodeConfig": {
"Type": "MD5",
"AddToHeader": true
},
"UserData": "This is my data."
}
}
}
}

参数名称
描述
类型
Response
结果的详情,详见 Response 详情
dict