tencent cloud

Preparations

1. Multi-File Zipping is implemented with Tencent Cloud Serverless Cloud Function (SCF). You need to log in to the COS console and create a multi-file zipping function.For the creation guide, see Multi-File Zipping.
2. After creating the function, click Instructions on the right of the function to configure it. The configurations are a JSON string, which will be described in detail in this document.

• If your function needs SCF authentication, you need to call the Invoke API provided by SCF to run your cloud function, where the ClientContext parameter is passed in JSON format (see Parameter Configuration Sample for details).
• For authentication-free functions, you can directly make HTTP requests to the corresponding API gateway to call the function.

Parameter Configuration Sample

Note：

In actual use, remove the comments from the code.

{
  "bucket": "examplebucket-1250000000",    // Bucket to deliver the final ZIP package
  "region": "ap-guangzhou",         // Region where the bucket resides
  "key": "mypack.zip",              // Name of the final ZIP package
  "flatten": false,                 // Whether to flatten source file paths
   /**
   * “sourceList” (a JSON array) is used to specify the list of source files that need to be zipped.
   * Each item includes the source file URL, “renamePath”, and more.
   * 
   * If the source file list is too long, you can JSON stringify the “sourceList” parameter.
   * Write the .json file, upload it to COS, and specify it with the “sourceConfigList” parameter.
   * 
   * You only need to specify either “sourceList” or “sourceConfigList”.
   */
  "sourceList": [
      {
          "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir1/file1.jpg",
          "renamePath": "dir1_rename/file1.jpg"
      },
      {
          "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir2/file2.mp4",
          "renamePath": "file2.mp4"
      },
      {
          "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/file3.md"
      }
  ],
  "sourceConfigList": [
      {
           "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/sourceList.json"
      }
  ]
}

The parameters are described as follows:

Function Response Sample

{
 code: 0,
 data: {
   Bucket: "examplebucket-1250000000",
   ETag: "\"35bb5e5f050e22bed8f443d8da5dbfb8-1\"",
   Key: "mypack.zip",
   Location: "examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/mypack.zip"
 },
 error: null,
 message: "cos zip file success"
}

The response parameters are as follows:

Samples

Sample 1: simple use case

Parameter configuration

{
 "bucket": "examplebucket-1250000000",
 "region": "ap-guangzhou",
 "key": "mypack.zip",
 "flatten": false,
 "sourceList": [
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir1/file1.jpg"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir2/file2.mp4"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/file3.md"
     }
 ]
}

ZIP package structure

mypack.zip
  ├── dir1/file1.jpg
  ├── dir2/file2.mp4
  └── file3.md

Sample 2: flattening the source file paths

Parameter configuration

{
 "bucket": "examplebucket-1250000000",
 "region": "ap-guangzhou",
 "key": "mypack.zip",
 "flatten": true,                  // Set “flatten” to “true” to flatten the source file paths.
 "sourceList": [
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir1/file1.jpg"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir2/file2.mp4"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/file3.md"
     }
 ]
}

ZIP package structure

mypack.zip
  ├── file1.jpg
  ├── file2.mp4
  └── file3.md

Sample3: renaming source file paths

Parameter configuration

{
 "bucket": "examplebucket-1250000000",
 "region": "ap-guangzhou",
 "key": "mypack.zip",
 "flatten": false,
 "sourceList": [
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir1/file1.jpg",
         // Rename “dir1/file1.jpg” to “dir1_rename/file1.jpg”.
         "renamePath": "dir1_rename/file1.jpg"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir2/file2.mp4",
         // Rename “dir2/file2.mp4” to “file2.mp4”.
         "renamePath": "file2.mp4"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/file3.md"
     }
 ]
}

ZIP package structure

mypack.zip
  ├── dir1_rename/file1.jpg
  ├── file2.mp4
  └── file3.md

Sample 4: renaming and flattening source file paths

Parameter configuration

{
 "bucket": "examplebucket-1250000000",
 "region": "ap-guangzhou",
 "key": "mypack.zip",
 "flatten": true,         // Set “flatten” to “true” to flatten source file paths.
 "sourceList": [
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir1/file1.jpg"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/dir2/file2.mp4"
     },
     {
         "url": "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/file3.md",
         // Rename “file3.md” to “dir3/file3.md”. As “renamePath” has a higher priority over “flatten”, the renamed path will not be flattened.
         "renamePath": "dir3/file3.md"
     }
 ]
}

ZIP package structure

mypack.zip
  ├── file1.jpg
  ├── file2.mp4
  └── dir3/file3.md