简介
本文档提供关于文件处理文件解压异步请求的 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,默认 XMLCallBackType="Url", # 回调类型,Url 或 TDMQ,默认 UrlCallBackMqConfig=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 | String | 否 | |
CallBack | 任务回调地址,优先级高于队列的回调地址,设置为 no 时,表示队列的回调地址不产生回调 | string | 否 |
CallBackFormat | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | string | 否 |
CallBackType | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | string | 否 |
CallBackMqConfig | dict | 否 | |
UserData | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | 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 | dict |