提交文件解压任务

最近更新时间:2023-09-28 17:28:11

我的收藏

简介

本文档提供关于文件处理文件解压异步请求的 API 概览以及 SDK 示例代码。
API
说明
用于异步提交文件解压任务

异步请求接口

功能说明

文件处理文件解压异步请求。

方法原型

def ci_create_file_uncompress_job(self, Bucket, InputObject, OutputBucket,
OutputRegion, FileUncompressConfig, QueueId=None, CallBack=None,
CallBackFormat=None, CallBackType=None, CallBackMqConfig=None,
UserData=None, **kwargs)

请求示例

def ci_create_file_uncompress_job():
body = {
'Prefix': 'zip/',
'UnCompressKey': base64.b64encode("123456".encode("utf-8")).decode('utf-8'),
'PrefixReplaced': '0'
}
mq_config = {
'MqRegion': 'bj',
'MqMode': 'Queue',
'MqName': 'queueName'
}
response = client.ci_create_file_uncompress_job(
Bucket=bucket_name, # 文件所在的桶名称
InputObject='zip/testmi.zip', # 需要解压的文件名
OutputBucket=bucket_name, # 指定输出文件所在的桶名称
OutputRegion=region, # 指定输出文件所在的地域
FileUncompressConfig=body, # 文件解压配置详情
CallBack="http://www.callback.com", # 回调url地址,当 CallBackType 参数值为 Url 时有效
CallBackFormat="JSON", # 回调信息格式 JSON 或 XML,默认 XML
CallBackType="Url", # 回调类型,Url 或 TDMQ,默认 Url
CallBackMqConfig=mq_config, # 任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填
UserData="this is my user data" # 透传用户信息, 可打印的 ASCII 码, 长度不超过1024
)
print(response)
return response

参数说明

参数名称
描述
类型
是否必选
Bucket
对象所在存储桶
String
InputObject
对象文件名,例如 folder/document.pdf
String
OutputBucket
指定输出文件所在的桶名称
String
OutputRegion
指定输出文件所在的地域
String
FileUncompressConfig
指定文件解压缩的处理规则
dict
QueueId
任务所在的队列 ID,开通文件处理服务后自动生成,请使用 查询队列 获取或通过 万象控制台获取队列ID 在存储桶中查询
String
CallBack
任务回调地址,优先级高于队列的回调地址,设置为 no 时,表示队列的回调地址不产生回调
string
CallBackFormat
任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式
string
CallBackType
任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型
string
CallBackMqConfig
任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填,详见 CallBackMqConfig 详情
dict
UserData
透传用户信息,可打印的 ASCII 码,长度不超过1024
String
参数FileUncompressConfig详情
参数名称
描述
类型
是否必选
Prefix
指定解压后输出文件的前缀,不填则默认保存在存储桶根路径。
String
UnCompressKey
解压密钥,传入时需先经过 base64 编码。
String
PrefixReplaced
指定解压后的文件路径是否需要替换前缀,有效值: 0:不添加额外的前缀,解压缩将保存在Prefix指定的路径下(不会保留压缩包的名称,仅将压缩包内的文件保存至指定的路径) 1:以压缩包本身的名称作为前缀,解压缩将保存在Prefix指定的路径下 2:以压缩包完整路径作为前缀,此时如果不指定Prefix,就是解压到压缩包所在的当前路径(包含压缩包本身名称) 默认值为0。
String

返回结果说明

{
"Response": {
"JobsDetail": {
"Code": "Success",
"Message": "",
"JobId": "f93984788066911ed89ed352d4d9d2084",
"State": "Submitted",
"CreationTime": "2022-07-18T15:16:43+0800",
"EndTime": "-",
"StartTime": "-",
"QueueId": "p2911917386e148639319e13c285cc774",
"Tag": "FileUncompress",
"Input": {
"BucketId": "test-1234567890",
"Object": "input/test.zip",
"Region": "ap-chongqing"
},
"Operation": {
"FileUncompressConfig": {
"Prefix": "output/",
"PrefixReplaced": 1
},
"Output": {
"Region": "ap-chongqing",
"Bucket": "test-1234567890"
},
"UserData": "This is my data."
}
}
}
}
参数名称
描述
类型
Response
结果的详情,详见 Response 详情
dict