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 actions.cam:passrole permission is required. The asynchronous processing interface performs read-write operations on COS resources through the "role" in CAM. The PassRole permission is used for role passing. For details, refer to 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>Watermark</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</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 | Create task Tag: Watermark | 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, which has a higher priority than the queue's callback address. When set to no, it indicates that 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 to be processed | String | Yes |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
WatermarkTemplateId | Request.Operation | watermark template ID, you can pass multiple watermark template IDs, up to 3 at most | String array | No |
Watermark | Request.Operation | watermark template parameters, same as Request.Watermark in the CreateWatermarkTemplate API, up to 3 can be passed | Container array | No |
Output | Request.Operation | Output configuration for results | 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 | Filename of the output result | String | Yes |
Wildcard | Meaning |
${ext} | muxing format encapsulation format |
${jobid} | Task Id |
<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>Watermark</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</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 | Detailed information of the task | 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 | Newly created task Tag: Watermark | String |
State | Response.JobsDetail | Task Status Submitted: submitted, pending execution Running: executing Success: execution successful Failed: execution failed Pause: task pause. When the queue is paused, to-be-executed tasks will become paused state. Cancel: Task execution cancelled | String |
CreationTime | Response.JobsDetail | Task Creation Time | String |
StartTime | Response.JobsDetail | Task Start 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 | Source file path | String |
Node Name (Keyword) | Parent Node | Description | Type |
WatermarkTemplateId | Response.JobsDetail.Operation | Request.Operation.WatermarkTemplateId | String array |
Watermark | Response.JobsDetail.Operation | In-request Request.Operation.Watermark | Container array |
Output | Response.JobsDetail.Operation | Request.Operation.Output | Container |
MediaInfo | Response.JobsDetail.Operation | Media information of the output file. Do not return if the task is incomplete. For details, see MediaInfo. | 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>Watermark</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:11+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>Watermark</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe22</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe23</WatermarkTemplateId><WatermarkTemplateId>t1318c5f428d474afba1797f84091cbe24</WatermarkTemplateId><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</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>Watermark</Tag><Input><Object>input/demo.mp4</Object></Input><Operation><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>Watermark content</Text><FontSize>30</FontSize><FontType>simfang.ttf</FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://test-1234567890.ci.ap-chongqing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height></Height><Transparency>100</Transparency></Image></Watermark><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<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>Watermark</Tag><Input><BucketId>test-123456789</BucketId><Object>input/demo.mp4</Object><Region>ap-chongqing</Region></Input><Operation><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>Watermark content</Text><FontSize>30</FontSize><FontType>simfang.ttf</FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://test-1234567890.ci.ap-chongqing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height></Height><Transparency>100</Transparency></Image></Watermark><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.mp4</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
フィードバック