腾讯云对象存储异步处理任务接口

简介

本文档提供关于异步处理任务接口的相关的 API 概览以及 SDK 示例代码。注意：需要 COS PHP SDK v2.4.0 及以上版本。旧版本可能存在 bug，使用时建议升级到 最新版本。

提交文档预览任务

功能说明

CreateDocProcessJobs 接口用于提交一个文档预览任务。注意：使用此接口前，请确保已打开官网控制台中数据处理下的文档处理开关，否则会报错 doc bucket unbinded, bucket's host is unavailable。如需使用文档转 HTML 功能，可直接将请求参数置于 URL 后方，SDK 仅负责签名计算操作。

示例代码

<?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->createDocProcessJobs(array(        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket        'Tag' => 'DocProcess', //任务的 Tag：DocProcess 固定值        // 'QueueId' => 'pd8e422a2ea134165a92f2012ea43****', //任务所在的队列 ID        'Input' => array(            'Object' => 'Append功能测试.pdf' //待操作的文件对象        ),        'Operation' => array(            'DocProcess' => array(                'SrcType' => 'pdf', //源数据的后缀类型                'TgtType' => 'png', //转换输出目标文件类型                'SheetId' => 0, //表格文件参数，转换第 X 个表，默认为1                'StartPage' => 1, //从第 X 页开始转换，默认为1                'EndPage' => 3, //转换至第 X 页，默认为-1，即转换全部页                'ImageParams' => '', //转换后的图片处理参数                'DocPassword' => '', //Office 文档的打开密码                'Comments' => 0, //是否隐藏批注和应用修订，默认为 0                'PaperDirection' => 0, //表格文件转换纸张方向，默认为0                'Quality' => 100, //生成预览图的图片质量，取值范围 [1-100]，默认值100                'Zoom' => 100, //预览图片的缩放参数，取值范围[10-200]， 默认值100            ),            'Output' => array(                'Region' => $region, //存储桶的地域                'Bucket' => 'examplebucket-1250000000', //存储结果的存储桶                'Object' => 'pic-${Page}.jpg', //输出文件路径            ),        ),    ));    // 请求成功    print_r($result);} catch (\Exception $e) {    // 请求失败    echo($e);}

参数说明

Request 中的具体数据描述如下：

Input 中的具体数据描述如下：

Operation 中的具体数据描述如下：

DocProcess 中的具体数据描述如下：

Output 中的具体数据描述如下：

返回参数说明

查询文档预览任务

功能说明

DescribeDocProcessJob 用于查询指定的文档预览任务。

示例代码

<?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->describeDocProcessJob(array(        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket        'Key' => 'examplejobid', // JobId    ));    // 请求成功    print_r($result);} catch (\Exception $e) {    // 请求失败    echo($e);}

参数说明

返回参数说明

拉取文档预览任务

功能说明

DescribeDocProcessJobs 用于拉取符合条件的文档预览任务。

示例代码

<?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->getDescribeDocProcessJobs(array(        'Bucket' => 'examplebucket-1250000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket        'QueueId' => 'pd8e422a2ea134165a92f2012ea43****', //拉取该队列 ID 下的任务        'Tag' => 'DocProcess', //任务的 Tag：DocProcess 固定值//      'NextToken' => '143486', //请求的上下文，用于翻页。上次返回的值//      'OrderByTime' => 'Desc', //Desc 或者 Asc。默认为 Desc//      'Size' => 2, //拉取的最大任务数。默认为10。最大为100//      'States' => 'All', //拉取该状态的任务，以,分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All。//      'StartCreationTime' => '2021-10-10T16:20:07+0800', //拉取创建时间大于该时间的任务//      'EndCreationTime' => '2021-10-10T16:20:07+0800', //拉取创建时间小于该时间的任务    ));    // 请求成功    print_r($result);} catch (\Exception $e) {    // 请求失败    echo($e);}

参数说明

返回参数说明



对象存储官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠