简介
本文档提供关于触发任务接口的 API 概览和 SDK 示例代码。
API | 操作描述 |
通过独立任务参数触发批量数据处理任务。 | |
通过工作流触发批量数据处理任务。 | |
查询批量数据处理任务。 | |
取消批量数据处理任务。 |
触发任务(独立节点)
功能说明
通过独立任务参数触发批量数据处理任务。
方法原型
public Guzzle\\Service\\Resource\\Model createInventoryTriggerJob(array $args = array());
请求示例
<?phprequire 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,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {// 触发任务(独立节点)https://cloud.tencent.com/document/product/460/80155$result = $cosClient->createInventoryTriggerJob(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Name' => '存量触发任务名称','Type' => 'Job','Input' => array(// 'Manifest' => '',// 'UrlFile' => '',// 'Prefix' => '','Object' => 'test01.png',),'Operation' => array('Tag' => '',// 'QueueId' => '',// 'QueueType' => '','TimeInterval' => array('Start' => '','End' => '',),'Output' => array('Region' => '','Bucket' => '','Object' => '',// 'AuObject' => '',// 'SpriteObject' => '',// 'StreamExtract' => array(// 'Index' => '',// 'Object' => '',// ),),'JobParam' => array(// 根据Tag输入相应参数,参数详情参考 https://cloud.tencent.com/document/product/460/80155'TemplateId' => '',// 'TranscodeTemplateId' => '',// 'WatermarkTemplateId' => '',// 'Animation' => ...,// 'Transcode' => ...,// 'SmartCover' => ...,// 'DigitalWatermark' => ...,// 'Watermark' => ...,// 'RemoveWatermark' => ...,// 'Snapshot' => ...,// 'SpeechRecognition' => ...,// 'ConcatTemplate' => ...,// 'VoiceSeparate' => ...,// 'VideoMontage' => ...,// 'SDRtoHDR' => ...,// 'VideoProcess' => ...,// 'SuperResolution' => ...,// 'Segment' => ...,// 'ExtractDigitalWatermark' => ...,// 'VideoTag' => ...,// 'TtsTpl' => ...,// 'NoiseReduction' => ...,),// 'UserData' => '',// 'JobLevel' => '',// 'CallBackFormat' => '',// 'CallBackType' => '',// 'CallBack' => '',// 'CallBackMqConfig' => array(// 'MqRegion' => '',// 'MqMode' => '',// 'MqName' => '',// ),),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Name | Request | 存量触发任务名称,支持中文、英文、数字、—和_,长度限制128字符 | String | 是 |
Type | Request | 批量处理任务类型:Job | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Manifest | Request.Input | COS 清单列表文件名,COS 清单生成的 manifest.json 文件 | String | 否 |
UrlFile | Request.Input | URL 文件名,文件中每行的 URL 为一个 COS 中对象的访问地址 | String | 否 |
Prefix | Request.Input | Object 前缀 | String | 否 |
Object | Request.Input | 文件路径 | String | 否 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TimeInterval | Request.Operation | 按时间过滤的触发范围 | Container | 否 |
Tag | Request.Operation | 创建的媒体任务类型 Tag | String | 是 |
Output | Request.Operation | 输出地址信息 当媒体任务类型不为 VideoTag 、 ExtractDigitalWatermark 、 MediaInfo 、 QualityEstimate 时,该参数必选 | Container | 否 |
JobParam | Request.Operation | 任务参数 | Container | 是 |
QueueId | Request.Operation | String | 否 | |
QueueType | Request.Operation | 队列类型,限制为 SpeedTranscoding ,当 Tag 为 Transcode 且 QueueId 为空时生效,表示为开启倍速转码 | String | 否 |
UserData | Request.Operation | 用户信息 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0 | String | 否 |
CallBackFormat | Request.Operation | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request.Operation | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request.Operation | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request.Operation | 任务回调 TDMQ 配置,当 CallBackType 为 TDMQ 时必填 | Container | 否 |
Container 类型 CallBackMqConfig 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
MqRegion | Request.Operation.CallBackMqConfig | 消息队列所属园区,目前支持园区 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港) | String | 是 |
MqMode | Request.Operation.CallBackMqConfig | 消息队列使用模式,默认 Queue : 主题订阅:Topic 队列服务: Queue | String | 是 |
MqName | Request.Operation.CallBackMqConfig | TDMQ 主题名称 | String | 是 |
Operation.Tag 支持的类型如下:
任务类型 | Tag |
视频转动图 | Animatin |
智能封面 | SmartCover |
音视频转码 | Transcode |
视频截图 | Snapshot |
语音识别 | SpeechRecognition |
音视频拼接 | Concat |
精彩集锦 | VideoMontage |
SDR to HDR | SDRtoHDR |
人声分离 | VoiceSeparate |
视频增强 | VideoProcess |
超级分辨率 | SuperResolution |
音视频转封装 | Segment |
视频标签 | VideoTag |
图片处理 | PicProcess |
数字水印 | DigitalWatermark |
提取数字水印 | ExtractDigitalWatermark |
异步获取媒体信息 | MediaInfo |
音视频流分离 | StreamExtract |
语音合成 | Tts |
音频降噪 | NoiseReduction |
视频质量分析 | QualityEstimate |
Container 类型 TimeInterval 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Start | Request.Operation.TimeInterval | 开始时间 | String | 否 | 0 | 扫描对象的上传时间 %Y-%m-%dT%H:%m:%S%z |
End | Request.Operation.TimeInterval | 结束时间 | String | 否 | 当前时间 | 扫描对象的上传时间 %Y-%m-%dT%H:%m:%S%z |
Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 限制 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 | 无 |
Bucket | Request.Operation.Output | 存储桶的名称 | String | 是 | 无 |
Object | Request.Operation.Output | 结果文件名称 | String | 否 | 当媒体任务类型不为 Snapshot 、 VoiceSeparate 、 StreamExtract 时,该参数必选 当媒体任务类型为SmartCover,且Request.Operation.JobParam.SmartCover.Count 大于1时,必须包含 ${Number} 参数 当媒体任务类型为 Snapshot,且 Snapshot.Count 大于1时,必须包含 ${Number} 参数 |
AuObject | Request.Operation.Output | 人声结果文件名 | String | 否 | 当媒体任务类型为 VideoSeParete 时,该参数有效,且不能和 Object 同时为空 |
SpriteObject | Request.Operation.Output | 雪碧图名 | String | 否 | 当媒体任务类型为 Snapshot 时,该参数有效,且不能和 Object 同时为空 当 Snapshot.Count 大于1时,必须包含 ${Number} 参数 仅支持 jpg |
StreamExtract | Request.Operation.Output | 流分离结果文件配置信息,当媒体任务类型为 StreamExtract 时该参数有效,且必选 | Container | 是 | 无 |
Container 类型 StreamExtract 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Index | Request.Operation.Output.StreamExtract | 流的编号,对应媒体信息中的 Response.MediaInfo.Stream.Video.Index 和 Response.MediaInfo.Stream.Audio.Index,详见 获取媒体信息接口,当输入媒体格式为 mxf 格式时,只支持提取 video 流 | String | 是 |
Object | Request.Operation.Output.StreamExtract | 结果输出文件名 | String | 是 |
Container 类型 JobParam 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TemplateId | Request.Operation.JobParam | 模板 ID | String | 否 |
TranscodeTemplateId | Request.Operation.JobParam | 转码模板 ID,当媒体任务类型为 VideoProcess 、SuperResolution 、 SDR2HDR 时有效 | Container | 否 |
Animation | Request.Operation.JobParam | 动图任务参数,当媒体任务类型为 Animation 时有效 | Container | 否 |
Transcode | Request.Operation.JobParam | 转码任务参数,当媒体任务类型为 Transcode 、VideoProcess 、SuperResolution 、 SDR2HDR 时该参数有效 | String | 否 |
SmartCover | Request.Operation.JobParam | 智能封面任务参数,当媒体任务类型为 SmartCover 时有效 | Container | 否 |
DigitalWatermark | Request.Operation.JobParam | 数字水印参数,当媒体任务类型为 Transcode 、VideoProcess 、SuperResolution 、 DigitalWatermark 时该参数有效 | Container | 否 |
Watermark | Request.Operation.JobParam | 水印模板参数,同创建水印模板 CreateMediaTemplate 接口的 Request.Watermark,当媒体任务类型为 Transcode 、 SDR2HDR 、 VideoProcess 、 SuperResolution 时该参数有效 | Container | 否 |
WatermarkTemplateId | Request.Operation.JobParam | 水印模板参数,同创建水印模板 CreateMediaTemplate 接口的 Request.Watermark ,当媒体任务类型为 Transcode 、 SDR2HDR 、 VideoProcess 、 SuperResolution 时该参数有效 | Container | 否 |
RemoveWatermark | Request.Operation.JobParam | 去除水印参数,当媒体任务类型为 Transcode 时有效 | Container | 否 |
Subtitles | Request.Operation.JobParam | 字幕参数,当媒体任务类型为 Transcode 时有效 | Container | 否 |
Snapshot | Request.Operation.JobParam | 截图任务参数,当媒体任务类型为 Snapshot 时有效 | Container | 否 |
SpeechRecognition | Request.Operation.JobParam | 语音识别任务参数,当媒体任务类型为 SpeechRecognition 时有效 | Container | 否 |
ConcatTemplate | Request.Operation.JobParam | 拼接任务参数,当媒体任务类型为 Concat 时有效 | Container | 否 |
VoiceSeparate | Request.Operation.JobParam | 人声分离任务参数,当媒体任务类型为 VoiceSeparate 时有效 | Container | 否 |
VideoMontage | Request.Operation.JobParam | 精彩集锦任务参数,当媒体任务类型为 VideoMontage 时有效 | Container | 否 |
SDRtoHDR | Request.Operation.JobParam | SDR2HDR 任务参数,当媒体任务类型为 SDRtoHDR 时有效 | Container | 否 |
VideoProcess | Request.Operation.JobParam | 视频增强任务参数,当媒体任务类型为 VideoProcess 时有效 | Container | 否 |
SuperResolution | Request.Operation.JobParam | 超分辨率任务参数,当媒体任务类型为 SuperResolution 时有效 | Container | 否 |
Segment | Request.Operation.JobParam | 转封装任务参数,当媒体任务类型为 Segment 时有效 | Container | 否 |
ExtractDigitalWatermark | Request.Operation.JobParam | 提取数字水印任务参数,当媒体任务类型为 ExtractDigitalWatermark 时有效 | Container | 否 |
VideoTag | Request.Operation.JobParam | 视频标签任务参数,当媒体任务类型为 VideoTag 时有效 | Container | 否 |
TtsTpl | Request.Operation.JobParam | 语音合成模板参数,当媒体任务类型为 Tts 时有效 | Container | 否 |
NoiseReduction | Request.Operation.JobParam | 音频降噪模板参数,当媒体任务类型为 NoiseReduction 时有效 | Container | 否 |
注意
优先使用 TemplateId,无 TemplateId 时使用对应任务类型的参数。
Container 类型 DigitalWatermark 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Message | Request.Operation.JobParam.DigitalWatermark | 数字水印嵌入的字符串信息,长度不超过64个字符,仅支持中文、英文、数字、_、-和* | String | 是 |
Type | Request.Operation.JobParam.DigitalWatermark | 水印类型,当前仅可设置为 Text | String | 是 |
Version | Request.Operation.JobParam.DigitalWatermark | 水印版本,当前仅可设置为 V1 | String | 是 |
IgnoreError | Request.Operation.JobParam.DigitalWatermark | 当添加水印失败是否忽略错误继续执行任务,限制为 true/false,默认为false 当 Request.Operation.Tag 为 DigitalWatermark 时,该参数无效,添加水印失败任务失败 | String | 否 |
返回结果示例
GuzzleHttp\\Command\\Result Object([Body] => GuzzleHttp\\Psr7\\Stream Object([stream:GuzzleHttp\\Psr7\\Stream:private] => Resource id #89[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] => NjRkNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=[ContentType] => application/xml[ContentLength] => 864[Bucket] => examplebucket-1250000000[Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/inventorytriggerjob[Response] => Array([JobsDetail] => Array([Code] => Success[CreationTime] => 2023-08-07T16:07:28+0800[EndTime] => -[Input] => Array([Object] => video01.mp4)[JobId] => b735cpc7a00f19asf798sd7f89s7f2e646[Name] => 存量触发任务名称[Operation] => Array([JobLevel] => 0[JobParam] => Array([TemplateId] => t01a00f19asf798sd7f89s7f2e646)[Output] => Array([Bucket] => examplebucket-1250000000[Object] => tmp/snapshot-${Number}.jpg[Region] => ap-guangzhou[SpriteObject] => Array())[QueueId] => Array()[Tag] => Snapshot[TimeInterval] => Array([End] => 2023-08-07T16:07:28+08:00))[StartTime] => 2023-08-07T16:07:28+0800[State] => Running[Type] => Job)))
触发任务(工作流)
功能说明
通过工作流触发批量数据处理任务。
方法原型
public Guzzle\\Service\\Resource\\Model createInventoryTriggerJob(array $args = array());
请求示例
<?phprequire 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,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {// 触发任务(工作流)https://cloud.tencent.com/document/product/460/76887$result = $cosClient->createInventoryTriggerJob(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Name' => '存量触发任务名称','Type' => 'Workflow','Input' => array(// 'Manifest' => '',// 'UrlFile' => '',// 'Prefix' => '','Object' => 'test01.png',),'Operation' => array('WorkflowIds' => 'w9938ed4b1435448783xxxxxxxxxxxxx',// 'TimeInterval' => array(// 'Start' => '',// 'End' => '',// ),),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Name | Request | 批量触发任务名称,支持中文、英文、数字、—和_,长度限制128字符 | String | 是 |
Type | Request | 批量处理任务类型: Workflow | String | 否 |
Input | Request | 待操作的媒体信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Manifest | Request.Input | COS 清单列表文件名,COS 清单生成的 manifest.json 文件 | String | 否 |
UrlFile | Request.Input | URL 文件名,文件中每行的 URL 为一个 COS 中对象的访问地址 | String | 否 |
Prefix | Request.Input | Object 前缀 | String | 否 |
Object | Request.Input | 媒体文件名 | String | 否 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
WorkflowIds | Request.Operation | 触发的工作流 ID | String | 是 |
TimeInterval | Request.Operation | 按时间过滤的触发范围 | Container | 否 |
Container 类型 TimeInterval 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Start | Request.TimeInterval | 开始时间 | String | 否 | 0 | 扫描对象的上传时间 %Y-%m-%dT%H:%m:%S%z |
End | Request.TimeInterval | 结束时间 | String | 否 | 当前时间 | 扫描对象的上传时间 %Y-%m-%dT%H:%m:%S%z |
返回结果示例
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] => NjJhOTg3ODNfZmNjYTNiOHAODISHOdlMmI=[ContentType] => application/xml[ContentLength] => 576[Bucket] => examplebucket-125000000[Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/inventorytriggerjob[Response] => Array([JobsDetail] => Array([Code] => Success[CreationTime] => 1-01-01T08:05:43+0805[EndTime] => -[Input] => Array([Object] => test01.png)[JobId] => b33872336ec7b11ecas0d80asd30d6f[Name] => 存量触发任务名称[Operation] => Array([TimeInterval] => Array([End] => 2022-06-15T15:17:23+08:00))[StartTime] => 1-01-01T08:05:43+0805[State] => Running[WorkflowIds] => w9938ed4b14aas890d8as09ddd)))
查询任务
功能说明
查询批量数据处理任务。
方法原型
public Guzzle\\Service\\Resource\\Model describeInventoryTriggerJob(array $args = array());
请求示例
<?phprequire 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,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {// https://cloud.tencent.com/document/product/460/76893$result = $cosClient->describeInventoryTriggerJob(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([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] => NjJhOThhNjhfNzgwYzAUOIDUSIOUDIOQ3NGE=[ContentType] => application/xml[ContentLength] => 670[Key] => b33872336ec7b11as8d9000030d6f[Bucket] => examplebucket-125000000[Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/inventorytriggerjob/b33872336ec7b11as8d9000030d6f[Response] => Array([JobsDetail] => Array([Code] => Success[CreationTime] => 2022-06-15T15:17:23+0800[EndTime] => 2022-06-15T15:21:17+0800[Input] => Array([Object] => test01.png)[JobId] => b33872336ec7b11as8d9000030d6f[Name] => 存量触发任务名称[Operation] => Array([TimeInterval] => Array([End] => 2022-06-15T15:17:23+08:00))[StartTime] => 2022-06-15T15:17:23+0800[State] => Success[WorkflowIds] => w9938eda8s09d8a9s0d809a5762bddebdd)[RequestId] => NjJhOThhNjhfNAOUSDOIDUo3NGE=))
取消任务
功能说明
取消批量数据处理任务。
方法原型
public Guzzle\\Service\\Resource\\Model cancelInventoryTriggerJob(array $args = array());
请求示例
<?phprequire 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,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {$result = $cosClient->cancelInventoryTriggerJob(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] => NjJhOThjOWFfNzgwYzOUADOIID8xNWU3ODY=[ContentType] => application/xml[ContentLength] => 0[Key] => b3c9das80d98a00f2ffd9[Bucket] => examplebucket-125000000[Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/inventorytriggerjob/b3c9das80d98a00f2ffd9)