Release Notes
Announcements
ci:CreateMediaJobs permission in the action of the authorization policy.cam:passrole permission to the action of the authorization policy. The interface for asynchronous processing will perform read and write operations on COS resources via CAM "roles". The PassRole permission is used to pass roles. For details, see CAM > Write Operations > PassRole Interface.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>ImageInspect</Tag><Input><Object>input/test.png</Object></Input><Operation><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 tasks: ImageInspect | String | Yes |
Input | Request | File information to be operated on | Container | Yes |
Operation | Request | Operational Rules | Container | No |
CallBackFormat | Request | The callback format for tasks, either JSON or XML, with XML as the default. This takes precedence over the callback format of the Queue. | String | No |
CallBackType | Request | The callback type for tasks, either Url or TDMQ, with Url as the default. This takes precedence over the callback type of the Queue. | String | No |
CallBack | Request | The callback address for tasks takes precedence over the callback address of the Queue. When set to "no", no callback will be generated for the Queue's callback address. | String | No |
CallBackMqConfig | Request | TDMQ configuration for task callback, required when CallBackType is TDMQ. For details, see CallBackMqConfig | Container | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
UserData | Request.Operation | Passthrough user information, printable ASCII characters, length up to 1024. | String | No |
JobLevel | Request.Operation | Range for the priority level of tasks: 0, 1, 2. The higher the level, the higher the priority. Default is 0. | String | No |
ImageInspect | Request.Operation | The parameters of the task | Container | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
AutoProcess | Request.Operation.ImageInspect | Whether to enable automatic actions such as moving to another directory, setting to private permissions, or deleting images upon detecting abnormalities. Values: true/false. Default is false. | String | No |
ProcessType | Request.Operation.ImageInspect | Specifying the actions to take after detecting abnormal images BackupObject: Move the images to abnormal_images_backup, which is automatically created by the backend. SwitchObjectToPrivate: Set the image permissions to private. DeleteObject: Delete images. Default value: BackupObject When AutoProcess is true, this parameter takes effect. | String | No |
Node Name (Keyword) | Parent Node | Description | Type | Required or Not |
Object | Request.Input | File path | String | Yes |
<Response><JobsDetail><Code>Success</Code><Message/><JobId>cda071f3af9e011ed8f900133752da9af</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p3a3b198088e74b76b31d553a77b656be</QueueId><Tag>ImageInspect</Tag><Input><BucketId>test-123456789</BucketId><Object>input/test.png</Object><Region>ap-chongqing</Region></Input><Operation><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 details | Container array |
Node Name (Keyword) | Parent Node | Description | Type |
Code | Response.JobsDetail | Error code, which applies when the State is Failed. | String |
Message | Response.JobsDetail | Error description, which applies when the State is Failed. | String |
JobId | Response.JobsDetail | ID of the newly created task | String |
Tag | Response.JobsDetail | Tag of the newly created task: ImageInspect | String |
State | Response.JobsDetail | Task Status Submitted: Submitted, pending execution Running: Running Success: Execution success Failed: Execution failure Pause: Task paused. When the Queue is paused, pending tasks will enter the paused state. Cancel: Task canceled. | String |
CreationTime | Response.JobsDetail | Creation Time of the Task | String |
StartTime | Response.JobsDetail | Start Time of the Task | String |
EndTime | Response.JobsDetail | End Time of the Task | String |
QueueId | Response.JobsDetail | Queue ID of the Task | String |
Input | Response.JobsDetail | The location of the input resource for the task | Container |
Operation | Response.JobsDetail | The rules of the task | Container |
Node Name (Keyword) | Parent Node | Description | Type |
Region | Response.JobsDetail.Input | Bucket Region | String |
BucketId | Response.JobsDetail.Input | Bucket where the source file is located | String |
Object | Response.JobsDetail.Input | Source file name | String |
Node Name (Keyword) | Parent Node | Description | Type |
UserData | Response.JobsDetail.Operation | Passthrough user information | String |
JobLevel | Response.JobsDetail.Operation | Task priority. | String |
ImageInspect | Response.JobsDetail.Operation | Container | |
ImageInspectResult | Response.JobsDetail.Operation | Results of abnormal image detection, not returned while the task is in progress | Container |
Node Name (Keyword) | Parent Node | Description | Type |
State | Response.JobsDetail.Operation.ImageInspectResult | The task status of the current node, which can be either Success or Failed. | String |
Code | Response.JobsDetail.Operation.ImageInspectResult | Error code, which is meaningful only when the State is Failed. | String |
Message | Response.JobsDetail.Operation.ImageInspectResult | Error description, only meaningful when the State is Failed. | String |
InputObjectName | Response.JobsDetail.Operation.ImageInspectResult | Input object name of the current node | String |
InputObjectUrl | Response.JobsDetail.Operation.ImageInspectResult | URL of the input object of the current node | String |
ProcessResult | Response.JobsDetail.Operation.ImageInspectResult | Details of the processing result of the current node | Container |
Node Name (Keyword) | Parent Node | Description | Type |
PicSize | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Size of the original image to be detected, in Bytes | Int |
PicType | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Detected original image type, for example, jpg, png. | String |
Suspicious | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Indicates whether files other than image formats are detected. false indicates a normal image file, true indicates a suspicious file containing other formats. | String |
SuspiciousBeginByte | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Starting byte position of the detected suspicious file, in Bytes | Int |
SuspiciousEndByte | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | End byte position of the detected suspicious file, in Bytes | Int |
SuspiciousSize | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Size of the detected suspicious file | Int |
SuspiciousType | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Type of the detected suspicious file, for example, MPEG-TS | String |
AutoProcessResult | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult | Result of automatic image processing after the image is detected as a suspicious file | Container |
Node Name (Keyword) | Parent Node | Description | Type |
Code | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult.AutoProcessResult | Error code of the automatic processing result, one of Success or Failed. | String |
Message | Response.JobsDetail.Operation.ImageInspectResult.ProcessResult.AutoProcessResult | Error message of the automatic processing result, valid when State is Failed. | 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>ImageInspect</Tag><Input><Object>input/test.png</Object></Input><Operation><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>cda071f3af9e011ed8f900133752da9af</JobId><State>Submitted</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>ImageInspect</Tag><Input><BucketId>test-123456789</BucketId><Object>input/test.png</Object><Region>ap-chongqing</Region></Input><Operation><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback