History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
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>FileUncompress</Tag><Input><Object>input/test.zip</Object></Input><Operation><FileUncompressConfig><Prefix>output/</Prefix><PrefixReplaced>1</PrefixReplaced></FileUncompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket></Output><UserData>This is my data.</UserData></Operation><QueueId>p2911917386e148639319e13c285cc774</QueueId><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON<CallBackFormat></Request>
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器。 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 表示任务的类型，文件解压默认为：FileUncompress。 | String | 是 |
Input | Request | 包含待操作的文件信息。 | Container | 是 |
Operation | Request | 包含文件解压的处理规则。 | Container | 是 |
QueueId | Request | 任务所在的队列 ID。 | String | 是 |
CallBackFormat | Request | 任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式。 | String | 否 |
CallBackType | Request | 任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型。 | String | 否 |
CallBack | Request | 任务回调的地址，优先级高于队列的回调地址。 | String | 否 |
CallBackMqConfig | Request | 任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig | Container | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件名，取值为文件在当前存储桶中的完整名称。 | String | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
FileUncompressConfig | Request.Operation | 指定文件解压的处理规则。 | Container | 是 |
UserData | Request.Operation | 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 | String | 否 |
Output | Request.Operation | 指定解压后的文件保存的存储桶信息。 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Prefix | Request.Operation.FileUncompressConfig | 指定解压后输出文件的前缀，不填则默认保存在存储桶根路径。 | String | 否 |
PrefixReplaced | Request.Operation.FileUncompressConfig | 指定解压后的文件路径是否需要替换前缀，有效值： - 0：不添加额外的前缀，解压缩将保存在Prefix指定的路径下（不会保留压缩包的名称，仅将压缩包内的文件保存至指定的路径）。 - 1：以压缩包本身的名称作为前缀，解压缩将保存在Prefix指定的路径下。 - 2：以压缩包完整路径作为前缀，此时如果不指定Prefix，就是解压到压缩包所在的当前路径（包含压缩包本身名称）。 - 默认值为0。 | String | 否 |
Prefix 为 456，则不同的PrefixReplaced值对应解压后的文件保存情况如下：
0：“图片.jpg”会保存在 456 目录下，“图片.jpg”的完整路径为 456/图片.jpg；
1：“图片.jpg”会以 test 为前缀保存在 456 目录下，“图片.jpg”的完整路径为 456/test/图片.jpg；
2：“图片.jpg”会以 123/test 为前缀保存在 456 目录下，“图片.jpg”的完整路径为 456/123/test/图片.jpg。节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域。 | String | 是 |
Bucket | Request.Operation.Output | 保存解压后文件的存储桶。 | String | 是 |
<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>FileUncompress</Tag><Input><BucketId>test-1234567890</BucketId><Object>input/test.zip</Object><Region>ap-chongqing</Region></Input><Operation><FileUncompressConfig><Prefix>output/</Prefix><PrefixReplaced>1</PrefixReplaced></FileUncompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket></Output><UserData>This is my data.</UserData></Operation></JobsDetail></Response>
节点名称（关键字） | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器。 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息。 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码，只有 State 为 Failed 时有意义。 | String |
Message | Response.JobsDetail | 错误描述，只有 State 为 Failed 时有意义。 | String |
JobId | Response.JobsDetail | 新创建任务的 ID。 | String |
Tag | Response.JobsDetail | 表示任务的类型，文件解压默认为：FileUncompress。 | String |
State | Response.JobsDetail | 任务的状态，为 Submitted(已提交)、Running(进行中)、Success(成功)、Failed(失败)、Pause(已暂停)、Cancel(已取消) 其中一个 | String |
CreationTime | Response.JobsDetail | 任务的创建时间。 | String |
StartTime | Response.JobsDetail | 任务的开始时间。 | String |
EndTime | Response.JobsDetail | 任务的结束时间。 | String |
QueueId | Response.JobsDetail | 任务所属的队列 ID。 | String |
Input | Response.JobsDetail | 被解压文件的信息。 | Container |
Operation | Response.JobsDetail | 文件解压的处理规则。 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Region | Response.JobsDetail.Input | 存储桶所在地域。 | String |
Bucket | Response.JobsDetail.Input | 文件所在的存储桶。 | String |
Object | Response.JobsDetail.Input | 被解压文件的文件名。 | String |
节点名称（关键字） | 父节点 | 描述 | 类型 |
UserData | Response.JobsDetail.Operation | 透传用户信息。 | String |
Output | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Output | Container |
FileUncompressConfig | Response.JobsDetail.Operation | 同请求中的 Request.Operation.FileUncompressConfig。 | Container |
FileUncompressResult | Response.JobsDetail.Operation | 文件解压的结果，任务未完成时不返回。 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Region | Response.JobsDetail.Operation.FileUncompressResult | 解压后文件保存的存储桶的地域 | String |
Bucket | Response.JobsDetail.Operation.FileUncompressResult | 解压后文件保存的存储桶 | String |
FileCount | Response.JobsDetail.Operation.FileUncompressResult | 解压后文件的个数 | 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>FileUncompress</Tag><Input><Object>input/test.zip</Object></Input><Operation><FileUncompressConfig><Prefix>output/</Prefix><PrefixReplaced>1</PrefixReplaced></FileUncompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket></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>FileUncompress</Tag><Input><BucketId>test-1234567890</BucketId><Object>input/test.zip</Object><Region>ap-chongqing</Region></Input><Operation><FileUncompressConfig><Prefix>output/</Prefix><PrefixReplaced>1</PrefixReplaced></FileUncompressConfig><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket></Output><UserData>This is my data.</UserData></Operation></JobsDetail></Response>
文档反馈