tencent cloud

Feedback

Submitting File Decompression Job

Last updated: 2024-03-01 14:57:12

    Overview

    This document provides an overview of APIs and SDK code samples for async file decompression requests.
    API
    Description
    Submits a file decompression job asynchronously.

    Async Request API

    Feature description

    This API is used to submit an async file decompression request.

    Method prototype

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

    Sample request

    def ci_create_file_uncompress_job():
    body = {
    'Prefix': 'output/',
    }
    response = client.ci_create_file_uncompress_job(
    Bucket=bucket_name,
    InputObject='test.zip',
    FileUncompressConfig=body
    )
    print(response)
    return response

    Parameter description

    Parameter
    Description
    Type
    Bucket
    Bucket of the object
    String
    InputObject
    Object name, such as folder/document.pdf
    String
    FileUncompressConfig
    File decompression rule. For more information, see "FileUncompressConfig" in Submitting File Decompression Job.
    dict
    QueueId
    ID of the queue where the job is in
    String
    CallBack
    Job callback address, which takes priority over that of the queue. If it is set to no, no callbacks will be generated at the callback address of the queue.
    string
    CallBackFormat
    Job callback format, which can be JSON or XML (default). It takes priority over that of the queue.
    string
    CallBackType
    Job callback type, which can be Url (default) or TDMQ. It takes priority over that of the queue.
    string
    CallBackMqConfig
    TDMQ configuration for job callback. This parameter is required if CallBackType is TDMQ. For more information, see "CallBackMqConfig" in Structure.
    dict
    UserData
    The user information passed through, which is printable ASCII codes of up to 1,024 in length.
    String

    Response description

    {
    "Response": {
    "JobsDetail": {
    "Code": "Success",
    "Message": "",
    "JobId": "f93984788066911ed89ed352d4d9d2084",
    "State": "Submitted",
    "CreationTime": "2022-07-18T15:4:43 PM+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."
    }
    }
    }
    }
    Parameter
    Description
    Type
    Response
    Response details. For more information, see "Response" in Submitting File Decompression Job.
    dict
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support