简介
本文档提供关于图片处理队列接口的 API 概览和 SDK 示例代码。注意 旧版本可能存在 bug,使用时建议升级到 最新版本。
API | 操作描述 |
查询图片处理队列 | 搜索图片处理队列。 |
更新图片处理队列 | 更新图片处理队列。 |
查询图片处理队列
功能说明
搜索图片处理队列。
方法原型
public Guzzle\Service\Resource\Model getPicQueueList(array $args = array());
请求示例
<?php
require dirname(__FILE__, 2) . '/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 { // 搜索图片处理队列 https://cloud.tencent.com/document/product/460/79395 $result = $cosClient->getPicQueueList(array( 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket// 'QueueIds' => 'xxx', // 队列 ID,以“,”符号分割字符串// 'State' => 'Active', // Active 表示队列内的作业会被媒体处理服务调度执行, Paused 表示队列暂停,作业不再会被媒体处理调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响// 'PageNumber' => '1', // 第几页// 'PageSize' => '10', // 每页个数 )); print_r($result);} catch (\Exception $e) { // 请求失败 echo($e);}
参数说明
Request 中的具体数据描述如下:
参数名称(关键字) | 描述 | 类型 | 是否必选 |
QueueIds | 队列 ID,以“,”符号分割字符串 | String | 否 |
State | 1. Active 表示队列内的作业会被媒体处理服务调度执行2. Paused 表示队列暂停,作业不再会被媒体处理调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响 | String | 否 |
PageNumber | 第几页,默认值1 | String | 否 |
PageSize | 每页个数,默认值10 | String | 否 |
返回结果示例
GuzzleHttp\Command\Result Object( [RequestId] => NjRjMjIxODBfMzUxNGSIOJOIDAJOIDg= [ContentType] => application/xml [ContentLength] => 765 [TotalCount] => 1 [PageNumber] => 1 [PageSize] => 10 [QueueList] => Array ( [0] => Array ( [BucketId] => examplebucket-1250000000 [QueueId] => pc7a00f19asf798sd7f89s7f2e646 [Name] => queue-pic-process [State] => Active [MaxSize] => 10000 [MaxConcurrent] => 10 [Category] => PicProcessing [UpdateTime] => 2023-06-25T15:18:16+0800 [CreateTime] => 2022-11-02T10:55:30+0800 [NotifyConfig] => Array ( [Url] => [State] => Off [Type] => [Event] => [ResultFormat] => XML [MqMode] => [MqRegion] => [MqName] => )
)
)
[Bucket] => examplebucket-1250000000 [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/picqueue)
更新图片处理队列
功能说明
更新图片处理队列。
方法原型
public Guzzle\Service\Resource\Model updatePicQueue(array $args = array());
请求示例
<?php
require dirname(__FILE__, 2) . '/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 { // 更新图片处理队列 https://cloud.tencent.com/document/product/460/79396 $result = $cosClient->updatePicQueue(array( 'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket 'Key' => '', // queueId 'Name' => 'queue-pic-process', 'State' => 'Active', 'NotifyConfig' => array( 'State' => 'Off',// 'Event' => '',// 'ResultFormat' => '',// 'Type' => '',// 'Url' => '',// 'MqMode' => '',// 'MqRegion' => '',// 'MqName' => '', ), )); // 请求成功 print_r($result);} catch (\Exception $e) { // 请求失败 echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Name | Request | 队列名称,长度不超过128 | String | 是 | 无 | 无 |
State | Request | 1. Active 表示队列内的作业会被媒体处理服务调度执行2. Paused 表示队列暂停,作业不再会被媒体处理调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响 | String | 是 | 无 | 无 |
NotifyConfig | Request | 回调配置 | Container | 是 | 无 | 无 |
Container 节点 NotifyConfig 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
State | Request.NotifyConfig | 回调开关,Off/On | String | 否 | Off | On/Off |
Event | Request.NotifyConfig | 回调事件 | String | 当 State=On时,必选 | 无 | 任务完成:TaskFinish;工作流完成:WorkflowFinish |
ResultFormat | Request.NotifyConfig | 回调格式 | String | 否 | XML | JSON/XML |
Type | Request.NotifyConfig | 回调类型 | String | 当 State=On时,必选 | 无 | Url 或 TDMQ |
Url | Request.NotifyConfig | 回调地址 | String | 当 State=On,且Type=Url时,必选 | 无 | 不能为内网地址 |
MqMode | Request.NotifyConfig | TDMQ 使用模式 | String | 当 State=On, 且Type=TDMQ时,必选 | Queue | 主题订阅:Topic 队列服务: Queue |
MqRegion | Request.NotifyConfig | TDMQ 所属园区 | String | 当 State=On,且Type=TDMQ时,必选 | 无 | 目前支持园区 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港) |
MqName | Request.NotifyConfig | TDMQ 主题名称 | String | 当 State=On,且Type=TDMQ时,必选 | 无 | 无 |
返回结果示例
GuzzleHttp\Command\Result Object( [RequestId] => NjRjMjIxODBfMzUxNGSIOJOIDAJOIDg= [ContentType] => application/xml [ContentLength] => 676 [Queue] => Array ( [BucketId] => examplebucket-1250000000 [QueueId] => pc7a00f19asf798sd7f89s7f2e646 [Name] => queue-pic-process [State] => Active [MaxSize] => 10000 [MaxConcurrent] => 10 [Category] => PicProcessing [UpdateTime] => 2023-07-27T16:17:11+0800 [CreateTime] => 2022-11-02T10:55:30+0800 [NotifyConfig] => Array ( [State] => Off [Event] => [ResultFormat] => XML [Type] => [Url] => [MqMode] => [MqRegion] => [MqName] => )
)
[Key] => pc7a00f19asf798sd7f89s7f2e646 [Bucket] => examplebucket-1250000000 [Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/picqueue/pc7a00f19asf798sd7f89s7f2e646)
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145944.html