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
ci:CreateMediaJobs permission is required. For details, see Cloud Infinite action.cam:passrole permission is required. The asynchronous processing interface uses the "role" in CAM to perform read-write operations on COS resources. The PassRole permission is used for role passing. For details, see Access Management > Write Operations > PassRole API.POST /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>SmartCover</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t16567cd58ade9411d952283873123b9b1</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Request | None. | Container for saving requests | Container | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Tag | Request | Tag for creating a task: SmartCover | String | Yes |
Input | Request | File information to be operated | Container | Yes |
Operation | Request | Operation rule | Container | Yes |
CallBackFormat | Request | Job callback format, JSON or XML, default XML, priority is higher than the callback format of the queue | String | No |
CallBackType | Request | Job callback type, Url or TDMQ, default Url, priority is higher than the callback type of the queue | String | No |
CallBack | Request | Job callback address, priority is higher than the queue's callback address. When set to no, it means the queue's callback address does not generate callbacks. | String | No |
CallBackMqConfig | Request | Task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig. | Container | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Object | Request.Input | File path | String | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
TemplateId | Request.Operation | Intelligent cover template ID | String | No |
SmartCover | Request.Operation | Intelligent cover parameter, same as Request.SmartCover in the Create Intelligent Cover Template API | Container | No |
Output | Request.Operation | Output configuration | Container | Yes |
UserData | Request.Operation | Pass through user information Printable ASCII code Length not exceeding 1024 | String | No |
JobLevel | Request.Operation | Task priority, level limit: 0, 1, 2. Higher levels indicate higher task priority. Default is 0. | String | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Region | Request.Operation.Output | Region of the storage bucket | String | Yes |
Bucket | Request.Operation.Output | Bucket for storing results | String | Yes |
Object | Request.Operation.Output | Output file name, must include ${number} wildcard when there are multiple output files | String | Yes |
Wildcard | Meaning |
${ext} | encapsulation format |
${jobid} | Task Id |
${number} | output index, counting begins from 0 |
<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>SmartCover</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><TemplateId>t16567cd58ade9411d952283873123b9b1</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
Node Name (Keyword) | Parent Node | Description | Type |
Response | None. | Container for saving results | Container |
Node Name (Keyword) | Parent Node | Description | Type |
JobsDetail | Response | Task detailed information | Container array |
Node Name (Keyword) | Parent Node | Description | Type |
Code | Response.JobsDetail | error code, meaningful only when State is Failed | String |
Message | Response.JobsDetail | error description, meaningful only when State is Failed | String |
JobId | Response.JobsDetail | Newly created task ID. | String |
Tag | Response.JobsDetail | Tag for the newly created task: SmartCover | String |
State | Response.JobsDetail | Task Status Submitted: submitted, pending execution Running: executing Success: execution successful Failed: execution failed Pause: task pause, when pausing a queue, to-be-executed tasks will become paused state Cancel: Task execution cancelled | String |
CreationTime | Response.JobsDetail | Task creation time | String |
EndTime | Response.JobsDetail | Task end time | String |
QueueId | Response.JobsDetail | String | |
Input | Response.JobsDetail | Input resource address of the task | Container |
Operation | Response.JobsDetail | Rules of the task | Container |
Node Name (Keyword) | Parent Node | Description | Type |
Region | Response.JobsDetail.Input | Region of the storage bucket | String |
Bucket | Response.JobsDetail.Input | Bucket for storing results | String |
Object | Response.JobsDetail.Input | Filename of the output result | String |
Node Name (Keyword) | Parent Node | Description | Type |
SmartCover | Response.JobsDetail.Operation | Request.Operation.SmartCover | String |
Output | Response.JobsDetail.Operation | Same as Request.Operation.Output in the request | Container |
MediaResult | Response.JobsDetail.Operation | Basic information of the output file. Do not return if the task is incomplete. For details, see MediaResult. | Container |
UserData | Response.JobsDetail.Operation | Pass through user information | String |
JobLevel | Response.JobsDetail.Operation | Task Priority | String |
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>SmartCover</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><TemplateId>t16567cd58ade9411d952283873123b9b1</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>SmartCover</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><TemplateId>t16567cd58ade9411d952283873123b9b1</TemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
POST /jobs HTTP/1.1Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************Host:test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>SmartCover</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><SmartCover><Format>jpg</Format><Width>1280</Width><Height>960</Height><Count>5</Count><DeleteDuplicates>true</DeleteDuplicates></SmartCover><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>SmartCover</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><SmartCover><Format>jpg</Format><Width>1280</Width><Height>960</Height><Count>5</Count><DeleteDuplicates>true</DeleteDuplicates></SmartCover><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/smartcover-${number}.jpg</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan