Release Notes
Announcements
API | Description |
Creates a multi-file zipping job. | |
Queries the result of a specified multi-file zipping job. |
public FileProcessJobResponse createFileProcessJob(FileProcessRequest request);
Request has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
tag | Request | Job type. It is FileCompress for multi-file zipping by default. | String | Yes |
operation | Request | File zipping rule. | Container | Yes |
queueId | Request | ID of the queue where the job is in | String | Yes |
callBackFormat | Request | Job callback format, which can be JSON or XML (default). It takes priority over that of the queue. | String | No |
callBackType | Request | Job callback type, which can be Url (default) or TDMQ. It takes priority over that of the queue. | String | No |
callBack | Request | Job callback address. It takes higher priority over that of the queue. | String | No |
callBackMqConfig | Request | TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ. | Container | No |
Operation has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
fileCompressConfig | Request.Operation | File zipping rule | Container | Yes |
userData | Request.Operation | The user information passed through, which is printable ASCII codes of up to 1,024 in length. | String | No |
output | Request.Operation | Address where the compressed file is stored | Container | Yes |
FileCompressConfig has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
flatten | Request.Operation.FileCompressConfig | Whether to remove the directory structure of the original file during file zipping. Valid values: 0: No. After file zipping, the original directory structure is retained.1: Yes. After file zipping, the original directory structure is removed and all files are at the same level.Assume that the original file URL is https://domain/source/test.mp4 and the original file directory is source/test.mp4. If this parameter is set to 1, the file directory in the ZIP file is test.mp4. If this parameter is set to 0, the file directory in the ZIP file is source/test.mp4. | String | Yes |
format | Request.Operation.FileCompressConfig | Zipping type. Valid values: zip, tar, tar.gz | String | Yes |
urlList | Request.Operation.FileCompressConfig | Files to be zipped can be sorted into an index file. The backend zips the files into a compressed file according to the file URL provided in the index file. The index file must be saved in the current bucket, and this field must provide the object address of the index file, for example, /test/index.csv. Index file format: Only CSV files in which one URL occupies one row (only files in the bucket are supported) are supported. If there are multiple columns, the first column is used as the URL by default. The number of files cannot exceed 10,000 and the total size cannot exceed 50 GB. Otherwise, the job will fail. | String | No |
prefix | Request.Operation.FileCompressConfig | Files with a specified prefix in the bucket can be zipped. To zip files in a specified directory, add / to the directory. For example, to zip files in the test directory, set this parameter to test/. The number of files cannot exceed 10,000 and the total size cannot exceed 50 GB. Otherwise, the job will fail. | String | No |
key | Request.Operation.FileCompressConfig | Multiple files in the bucket can be zipped. The number of files cannot exceed 1,000 and the total size cannot exceed 50 GB. Otherwise, the job will fail. | String array | No |
Output has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
region | Request.Operation.Output | Bucket region | String | Yes |
bucket | Request.Operation.Output | Bucket where the compressed file is stored | String | Yes |
object | Request.Operation.Output | Name of the compressed file | String | Yes |
FileProcessJobResponse object response information is returned.//1. Create a job request objectFileProcessRequest request=new FileProcessRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("demo-1234567890");request.setTag(FileProcessJobType.FileCompress);FileCompressConfig fileCompressConfig=request.getOperation().getFileCompressConfig();fileCompressConfig.setFormat("zip");fileCompressConfig.setFlatten("0");List<String> keyList=fileCompressConfig.getKey();keyList.add("mark/pic-1.jpg");keyList.add("mark/pic-1.pdf");//`QueueId` should be obtained in the console.request.setQueueId("p1ff062b35a494cf0ac4b572df22****");MediaOutputObject output=request.getOperation().getOutput();output.setBucket("demo-1234567890");output.setRegion("ap-shanghai");output.setObject("output/demo.zip");//3. Call the API to get the job response objectFileProcessJobResponse response=client.createFileProcessJob(request);
public FileProcessJobResponse describeFileProcessJob(FileProcessRequest request);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
jobId | ID of the job to be queried. | String | Yes |
FileProcessJobResponse.//1. Create a job request objectFileProcessRequest request = new FileProcessRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("demo-1234567890");request.setJobId("fda7eb1607b8411ed8c182156726*****");//3. Call the API to get the job response objectFileProcessJobResponse response = client.describeFileProcessJob(request);
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback