帮你快速理解、总结文档立即下载
文档中心>数据万象>SDK 文档>Python SDK>文件处理>多文件打包压缩>提交多文件打包压缩任务

提交多文件打包压缩任务

最近更新时间：2024-10-17 21:07:02
我的收藏

本页目录：

简介

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

异步请求接口

功能说明

文件处理多文件打包压缩异步请求。

方法原型

    def ci_create_file_compress_job(self, Bucket, OutputBucket, OutputRegion,   
        OutputObject, FileCompressConfig, QueueId=None, CallBack=None, 
        CallBackFormat=None, CallBackType=None, CallBackMqConfig=None, 
        UserData=None, **kwargs)

请求示例

    def ci_create_file_compress_job():
        body = {
            'Flatten': '0',
            'Format': 'zip',
            'Prefix': '/',
        }
        response = client.ci_create_file_compress_job(
            Bucket=bucket_name,
            OutputBucket=bucket_name,
            OutputRegion='ap-guangzhou',
            OutputObject='result.zip',
            FileCompressConfig=body,
            CallBack="http://www.callback.com",
            CallBackType="Url",
            CallBackFormat="XML",
            UserData="my data"
        )
        print(response)
        return response

参数说明

参数名称
描述
类型
是否必选
Bucket
对象所在存储桶
String
是
QueueId
任务所在的队列 ID，开通文件处理服务后自动生成，请使用 查询队列 获取或通过 万象控制台 在存储桶中查询
String
否
OutputRegion
存储桶的地域
String
是
OutputBucket
存储结果的存储桶
String
是
OutputObject
输出文件路径
String
是
FileCompressConfig
指定文件压缩的处理规则，详见 FileCompressConfig 详情
dict
是
CallBack
任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
string
否
CallBackFormat
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
string
否
CallBackType
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
string
否
CallBackMqConfig
任务回调TDMQ配置，当 CallBackType 为 TDMQ 时必填，详见 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": "FileCompress",
            "Operation": {
                "FileCompressConfig": {
                    "Prefix": "test/",
                    "Format": "zip",
                    "Flatten": 0
                },
                "Output": {
                    "Region": "ap-chongqing",
                    "Bucket": "test-1234567890",
                    "Object": "output/test.zip"
                },
                "UserData": "This is my data."
            }
        }
    }
}

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

中国站