简介
本文档提供关于图片处理任务接口的 API 概览和 SDK 示例代码。
API | 操作描述 |
提交图片处理任务 | 提交图片处理任务 |
查询任务结果 | 查询指定的任务 |
提交图片处理任务
功能说明
提交一个图片处理任务。
方法原型
public Guzzle\Service\Resource\Model createMediaPicProcessJobs(array $args = array());
请求示例
示例一: 使用模板
<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\Cos\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部,默认为 http 'credentials'=> array( 'secretId' => $secretId , 'secretKey' => $secretKey)));try { $result = $cosClient->createMediaPicProcessJobs(array( 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Tag' => 'PicProcess', // 'QueueId' => 'pcf4d6d9e5e734asd0as8d09as8d09a8d0', 'Input' => array( 'Object' => 'test01.png' ), 'Operation' => array( 'TemplateId' => 't1648745f76c354e8ad8a09sd890ad80a8d', 'Output' => array( 'Region' => $region, 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Object' => 'picprocess.jpg', ),// 'UserData' => 'xxx', // 透传用户信息// 'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0 ), 'CallBack' => '', )); // 请求成功 print_r($result);} catch (\Exception $e) { // 请求失败 echo($e);}
示例二: 自定义参数
<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\Cos\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部,默认为 http 'credentials'=> array( 'secretId' => $secretId , 'secretKey' => $secretKey)));try { $result = $cosClient->createMediaPicProcessJobs(array( 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Tag' => 'PicProcess', // 'QueueId' => 'pcf4d6d9e5e734asd0as8d09as8d09a8d0', 'Input' => array( 'Object' => 'test01.png' ), 'Operation' => array( 'PicProcess' => array( 'IsPicInfo' => '', 'ProcessRule' => '', ), 'Output' => array( 'Region' => $region, 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由 BucketName-Appid 组成,可以在 COS 控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Object' => 'picprocess.jpg', ),// 'UserData' => 'xxx', // 透传用户信息// 'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0 ), 'CallBack' => '', )); // 请求成功 print_r($result);} catch (\Exception $e) { // 请求失败 echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:PicProcess | 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 | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | 任务回调 TDMQ 配置,当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 媒体文件名 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
PicProcess | Request.Operation | 指定该任务的参数,同创建图片处理模板接口中的 Request.PicProcess | Container | 否 |
TemplateId | Request.Operation | 指定的模板 ID | String | 否 |
Output | Request.Operation | 结果输出地址 | Container | 是 |
UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0 | String | 否 |
注意:优先使用 TemplateId,无 TemplateId 时使用对应任务类型的参数。Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 结果文件的名字 | String | 是 |
返回结果示例
GuzzleHttp\Command\Result Object( [Body] => GuzzleHttp\Psr7\Stream Object ( [stream:GuzzleHttp\Psr7\Stream:private] => Resource id #88 [size:GuzzleHttp\Psr7\Stream:private] => [seekable:GuzzleHttp\Psr7\Stream:private] => 1 [readable:GuzzleHttp\Psr7\Stream:private] => 1 [writable:GuzzleHttp\Psr7\Stream:private] => 1 [uri:GuzzleHttp\Psr7\Stream:private] => php://temp [customMetadata:GuzzleHttp\Psr7\Stream:private] => Array ( )
)
[RequestId] => NjI2N2E4NTRfNzgwYzAJODIAUSIODUAU3ZQ== [ContentType] => application/xml [ContentLength] => 795 [Bucket] => examplebucket-1250000000 [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/pic_jobs [Response] => Array ( [JobsDetail] => Array ( [Code] => Success [CreationTime] => 2022-04-26T16:07:48+0800 [EndTime] => - [Input] => Array ( [BucketId] => examplebucket-1250000000 [Object] => test01.png [Region] => ap-guangzhou )
[JobId] => cf62e1d50c5sa98d09a8d0a6cf06 [Message] => [Operation] => Array ( [Output] => Array ( [Bucket] => examplebucket-1250000000 [Object] => picprocess.jpg [Region] => ap-guangzhou )
[TemplateId] => t1648745f76asd70as8d90as8d0aa8a09 [TemplateName] => PicProcess-1 [UserData] => xxx [UserData] => 0 )
[QueueId] => pcf4d6d9e5e734d0b82eas90d8a90sdd0 [StartTime] => - [State] => Submitted [Tag] => PicProcess )
)
)
查询任务结果
功能说明
查询指定的任务。
方法原型
public Guzzle\Service\Resource\Model describeMediaJob(array $args = array());
请求示例
<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\Cos\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部,默认为 http 'credentials'=> array( 'secretId' => $secretId , 'secretKey' => $secretKey)));try { // 查询指定的任务 $result = $cosClient->describeMediaJob(array( 'Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Key' => '', // jobId )); // 请求成功 print_r($result);} catch (\Exception $e) { // 请求失败 echo($e);}
参数说明
Request 中的具体数据描述如下:
参数名称 | 类型 | 描述 | 是否必填 |
Bucket | String | 存储桶名称,格式:BucketName-APPID | 是 |
Key | String | 需要查询的任务 ID | 是 |
返回结果示例
GuzzleHttp\Command\Result Object( [RequestId] => NjRkMNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg= [ContentType] => application/xml [ContentLength] => 1836 [Key] => j7380pc7a00f19asf798sd7f89s7f2e646 [Bucket] => examplebucket-1250000000 [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs/j7380pc7a00f19asf798sd7f89s7f2e646 [Response] => Array ( [JobsDetail] => Array ( [Code] => Success [CreationTime] => 2023-08-07T16:07:28+0800 [EndTime] => 2023-08-07T16:07:29+0800 [Input] => Array ( [BucketId] => examplebucket-1250000000 [Object] => object [Region] => ap-guangzhou )
[JobId] => j7380pc7a00f19asf798sd7f89s7f2e646 [Message] => [Operation] => Array ( [JobLevel] => 0 [Output] => Array ( [Bucket] => examplebucket-1250000000 [Object] => tmp/out_object [Region] => ap-guangzhou )
[TemplateId] => t0pc7a00f19asf798sd7f89s7f2e646 [TemplateName] => TemplateName )
[QueueId] => pc6f4d28f798sd7f89s7f2e646bffb5a [QueueType] => QueueType [StartTime] => 2023-08-07T16:07:28+0800 [State] => Success [Tag] => Tag ) ))
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145984.html