POST /file_jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
<Request><Tag>FileCompress</Tag><Operation><FileCompressConfig><Prefix>test/</Prefix><Format>zip</Format><Flatten>0</Flatten></FileCompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket><Object>output/test.zip</Object></Output><UserData>This is my data.</UserData></Operation><QueueId>p2911917386e148639319e13c285cc774</QueueId><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
Node Name (Keyword) | Parent Node | Description | Type | Required |
Request | None | Request container | Container | Yes |
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 > CallBackMqConfig, 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 CVS 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 |
<Response><JobsDetail><Code>Success</Code><Message/><JobId>f93984788066911ed89ed352d4d9d2084</JobId><State>Submitted</State><CreationTime>2022-07-18T15:16:43+0800</CreationTime><EndTime>-</EndTime><StartTime>-</StartTime><QueueId>p2911917386e148639319e13c285cc774</QueueId><Tag>FileCompress</Tag><Operation><FileCompressConfig><Prefix>test/</Prefix><Format>zip</Format><Flatten>0</Flatten></FileCompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket><Object>output/test.zip</Object></Output><UserData>This is my data.</UserData></Operation></JobsDetail></Response>
Node Name (Keyword) | Parent Node | Description | Type |
Response | None | Result storage container | Container |
Response has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type |
JobsDetail | Response | Job details | Container |
JobsDetail has the following sub-nodes: Node Name (Keyword) | Parent Node | Description | Type |
Code | Response.JobsDetail | Error code, which is returned only if State is Failed | String |
Message | Response.JobsDetail | Error message, which is returned only if State is Failed | String |
JobId | Response.JobsDetail | Job ID | String |
Tag | Response.JobsDetail | Job type. It is FileCompress for multi-file zipping by default. | String |
State | Response.JobsDetail | Job status. Valid values: Submitted (submitted), Running (running), Success (successful), Failed (failed), Pause (paused), Cancel (canceled) | String |
CreationTime | Response.JobsDetail | Job creation time | String |
StartTime | Response.JobsDetail | Job start time | String |
EndTime | Response.JobsDetail | Job end time | String |
QueueId | Response.JobsDetail | ID of the queue where the job is in | String |
Operation | Response.JobsDetail | Multi-file zipping rule | Container |
Operation has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type |
UserData | Response.JobsDetail.Operation | The user information passed through. | String |
Output | Response.JobsDetail.Operation | Same as Request.Operation.Output in the request. | Container |
FileCompressConfig | Response.JobsDetail.Operation | Same as Request.Operation.FileCompressConfig in the request. | Container |
FileCompressResult | Response.JobsDetail.Operation | Multi-file zipping result, which will not be returned when the job is not completed. | Container |
FileCompressResult has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type |
Region | Response.JobsDetail.Operation.FileCompressResult | Region of the bucket where the compressed file is stored | String |
Bucket | Response.JobsDetail.Operation.FileCompressResult | Bucket where the compressed file is stored | String |
Object | Response.JobsDetail.Operation.FileCompressResult | Name of the compressed file | String |
POST /file_jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>FileCompress</Tag><Operation><FileCompressConfig><Prefix>test/</Prefix><Format>zip</Format><Flatten>0</Flatten></FileCompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket><Object>output/test.zip</Object></Output><UserData>This is my data.</UserData></Operation><QueueId>p2911917386e148639319e13c285cc774</QueueId><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 18 Jul 2022 19:37:29 GMTServer: tencent-cix-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><JobsDetail><Code>Success</Code><Message/><JobId>f93984788066911ed89ed352d4d9d2084</JobId><State>Submitted</State><CreationTime>2022-07-18T15:16:43+0800</CreationTime><EndTime>-</EndTime><StartTime>-</StartTime><QueueId>p2911917386e148639319e13c285cc774</QueueId><Tag>FileCompress</Tag><Operation><FileCompressConfig><Prefix>test/</Prefix><Format>zip</Format><Flatten>0</Flatten></FileCompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket><Object>output/test.zip</Object></Output><UserData>This is my data.</UserData></Operation></JobsDetail></Response>
피드백