详情页标题前

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

• 腾讯云
详情页1

简介

本文档提供关于文档预览任务接口的 API 概览以及 SDK 示例代码。

API 说明
提交文档预览任务 用于提交一个文档预览任务
查询指定的文档预览任务 用于查询指定的文档预览任务
拉取符合条件的文档预览任务 用于拉取符合条件的文档预览任务

提交文档预览任务

功能说明

用于提交一个文档预览任务。

示例代码

function createDocProcessJobs() {  var config = {    // 需要替换成您自己的存储桶信息    Bucket: 'examplebucket-1250000000', /* 存储桶，必须 */    Region: 'COS_REGION', /* 存储桶所在地域，必须字段 */  };  var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs';  var url = 'https://' + host;  var body = COS.util.json2xml({    Request: {      Tag: 'DocProcess',      Input: {        Object: '文档.docx', // 存在 cos 里的路径      },      Operation: {        DocProcess: {          TgtType: 'jpg',        },        Output: {          Bucket: config.Bucket,          Region: config.Region,          Object: '文档转码_${Number}.jpg', // 转码后存到 cos 的路径        },      },      QueueId: 'pa2e2c3d3fae042de909cafc16f1d801b', // 替换为自己的QueueId    }  });  cos.request({      Method: 'POST',      Key: 'doc_jobs',      Url: url,      Body: body,      ContentType: 'application/xml',  },  function(err, data){      console.log(err || data);  });}createDocProcessJobs();

参数说明

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

参数名称 类型 描述 是否必填
Bucket String 存储桶名称，格式：BucketName-APPID 是
Operation Array 操作规则 是
Tag String 创建任务的 Tag，目前仅支持：DocProcess 是
Input Array 待操作的文件对象 是
QueueId String 任务所在的队列 ID 是

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

参数名称 类型 描述 是否必填
Object String 文件在 COS 上的文件路径，Bucket 由 Host 指定 是

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

参数名称 类型 描述 是否必填
DocProcess Array 当 Tag 为 DocProcess 时有效，指定该任务的参数 是
Output Array 结果输出地址 是

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

参数名称 类型 描述 是否必填
srcType String 源数据的后缀类型，当前文档转换根据 cos 对象的后缀名来确定源数据类型，当 cos 对象没有后缀名时，可以设置该值 否
tgtType String 转换输出目标文件类型： jpg，转成 jpg 格式的图片文件；如果传入的格式未能识别，默认使用 jpg 格式 png，转成 png 格式的图片文件 pdf，转成 pdf 格式文件（暂不支持指定页数） 否
sheetId Integer 表格文件参数，转换第 X 个表，默认为1；设置 SheetId 为0，即转换文档中全部表 否
startPage Integer 从第 X 页开始转换；在表格文件中，一张表可能分割为多页转换，生成多张图片。StartPage 表示从指定 SheetId 的第 X 页开始转换。默认为1 否
endPage Integer 转换至第 X 页；在表格文件中，一张表可能分割为多页转换，生成多张图片。EndPage 表示转换至指定 SheetId 的第 X 页。默认为-1，即转换全部页 否
imageParams String 转换后的图片处理参数，支持 基础图片处理 所有处理参数，多个处理参数可通过 管道操作符 分隔，从而实现在一次访问中按顺序对图片进行不同处理 否
docPassword String Office 文档的打开密码，如果需要转换有密码的文档，请设置该字段 否
comments Integer 是否隐藏批注和应用修订，默认为 0；0：隐藏批注，应用修订；1：显示批注和修订 否
paperDirection Integer 表格文件转换纸张方向，0代表垂直方向，非0代表水平方向，默认为0 否
quality Integer 生成预览图的图片质量，取值范围 [1-100]，默认值100。 例：值为100，代表生成图片质量为100% 否
zoom Integer 预览图片的缩放参数，取值范围[10-200]， 默认值100。 例：值为200，代表图片缩放比例为200% 即放大两倍 否

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

参数名称 类型 描述 是否必填
Region String 存储桶的地域 是
Bucket String 存储结果的存储桶 是
Object String 输出文件路径 是

返回结果说明

详情请参见 提交文档转码任务。

参数名称 描述 类型
err 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功则为空，更多详情请参见 错误码 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象，如果请求发生错误，则为空 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
– Response – Object
– – – JobsDetail 任务的详细信息 Container
– – – – Code 错误码，只有 State 为 Failed 时有意义 String
– – – – Message 错误描述，只有 State 为 Failed 时有意义 String
– – – – JobId 新创建任务的 ID String
– – – – Tag 新创建任务的 Tag：DocProcess String
– – – – State 任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 String
– – – – CreationTime 任务的创建时间 String
– – – – QueueId 任务所属的队列 ID String
– – – – Input 该任务的输入文件路径，详情请参见 CreateDocProcessJobsOptions.Input Container
– – – – Operation 该任务的规则，详情请参见 CreateDocProcessJobsOptions.Operation Container

查询指定文档预览任务

功能说明

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

示例代码

function describeDocProcessJob() {  var config = {    // 需要替换成您自己的存储桶信息    Bucket: 'examplebucket-1250000000', /* 存储桶，必须 */    Region: 'COS_REGION', /* 存储桶所在地域，必须字段 */  };  var jobId = 'd87fbabd07b8611ed974b3f4b4064872e';  // 替换为自己的jobId  var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs/' + jobId;  var url = 'https://' + host;  cos.request({      Method: 'GET',      Key: 'doc_jobs/' + jobId,      Url: url,  },  function(err, data){      console.log(err || data);  });}describeDocProcessJob();

参数说明

参数名称 描述 类型
jobId 文档预览任务 ID String

返回结果说明

详情请参见 查询指定的文档转码任务。

参数名称 描述 类型
err 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功则为空，更多详情请参见 错误码 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象，如果请求发生错误，则为空 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
– Response – Object
– – JobsDetail 任务的详细信息， 同 CreateDocProcessJobs 接口的 Response.JobsDetail 节点 Container
– – NonExistJobIds 查询的 ID 中不存在的任务，所有任务都存在时不返回 String

拉取符合条件的文档预览任务

功能说明

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

示例代码

function describeDocProcessJobs() {  var config = {    // 需要替换成您自己的存储桶信息    Bucket: 'examplebucket-1250000000', /* 存储桶，必须 */    Region: 'COS_REGION', /* 存储桶所在地域，必须字段 */  };  var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/doc_jobs';  var url = 'https://' + host;  cos.request({      Method: 'GET',      Key: 'doc_jobs',      Url: url,      Query: {        queueId: 'pa2e2c3d3fae042de909cafc16f1d801b', // 替换为自己的QueueId        tag: 'DocProcess',      },  },  function(err, data){      console.log(err || data);  });}describeDocProcessJobs();

参数说明

参数名称 描述 类型
queueId 拉取该队列 ID 下的任务 String
tag 任务的 Tag：DocProcess String
orderByTime Desc 或者 Asc。默认为 Desc String
nextToken 请求的上下文，用于翻页。上次返回的值 String
size 拉取的最大任务数。默认为10，最大值为100 Int
states 拉取该状态的任务，以,分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All String
startCreationTime 拉取创建时间大于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z String
endCreationTime 拉取创建时间小于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z String

返回结果说明

详情请参见 拉取符合条件的文档转码任务。

参数名称 描述 类型
err 请求发生错误时返回的对象，包括网络错误和业务错误。如果请求成功则为空，更多详情请参见 错误码 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
data 请求成功时返回的对象，如果请求发生错误，则为空 Object
– statusCode 请求返回的 HTTP 状态码，例如200、403、404等 Number
– headers 请求返回的头部信息 Object
– Response – Object
– – JobsDetail 任务的详细信息，同 CreateDocProcessJobs 接口中的 Response.JobsDetail 节点 Container
– – NextToken 翻页的上下文 Token String

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

转转请注明出处：https://www.yunxiaoer.com/145857.html

赞 (0)
0
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

相关推荐

  • 百问求答（16）OceanBase 问题专场！回答问题赢飞科剃须刀等好礼-云小二-阿里云 阿里云知识库

    百问求答（16）OceanBase 问题专场！回答问题赢飞科剃须刀等好礼-云小二-阿里云

    阿里云开发者社区作为一个充满活力的技术社区，有许多技术同道在这里勤学好问。为了让这些用户的疑惑得到解答，我们举办了“百问求答”活动，本期为OceanBase专场，期待用你的技术知识储备帮助同行解决难题，赢取飞科剃须刀等好礼，还有机会成为阿里云开发者社区“乘风问答官”，享受专属权益！赶快参与起来！ 奖项设置： 重要说明 图文并茂定义：图片需要能起到辅助回答的说…

    2023年12月27日
  • 云数据仓库ADB中我想问下ADB 数据库 分区 一个分区 大概存储多少数据是合理的？-云小二-阿里云 阿里云

    云数据仓库ADB中我想问下ADB 数据库 分区 一个分区 大概存储多少数据是合理的？-云小二-阿里云

    “云数据仓库ADB中我想问下ADB 数据库 分区 一个分区 大概存储多少数据是合理的？一个分区 一千万数据 可以吗 ？“ 以下为热心网友提供的参考意见 “参考文档：https://help.aliyun.com/zh/analyticdb-for-mysql/product-overview/limits?spm=a2c4…

    2023年12月5日
  • 信息流广告，信息流部分建议宽度830px，只针对默认列表样式，顺序随机

  • 腾讯云云点播音画质检测

    简介 音画质检测，基于先进的 AI 算法对音视频中的画面帧以及声音质量进行检测并提供整体质量检测评分，涵盖视频画面抖动重影、模糊、低光过曝、花屏、音频异常等多种检测类型。根据检测结果，用户可以快速定位音视频质量问题，有针对性地进行音画质修复和增强，提升音视频质量修复效率。 检测项 说明 视频画面抖动、重影 检测因视频拍摄过程中因相机架设不稳和环境，导致的视频…

    腾讯云 2023年12月9日
  • 腾讯云轻量应用服务器添加域名解析云小二 腾讯云

    腾讯云轻量应用服务器添加域名解析云小二

    操作场景 通过轻量应用服务器控制台添加域名后，您可以继续添加域名解析。通过添加域名解析可将域名（例如 cloud.tencent.com）指向一个 IP 地址（外网地址），方便您通过域名来访问网站。 注意事项 轻量应用服务器控制台当前仅支持添加 A 记录。添加的域名解析的主机记录为 @ 时，意味着您可以直接通过域名访问部署的网站。例如：主机名为 @.exam…

    2023年12月9日

  • 腾讯云云点播关于直播剪辑正式商业计费的公告

    为了满足用户在直播过程中（即直播尚未结束时）对直播内容实时剪辑生成精彩片段，用于宣发吸引更多用户观看。腾讯云点播推出了 直播剪辑 功能，用户可以在直播过程中选择一个片段，实时剪辑生成一个新的视频（HLS 格式），同时可以将其视频内容立即分享出去，或者长久保存起来。腾讯云点播（VOD）服务于2022年12月01日新增 直播剪辑 计费项，并对用户发起的 直播剪辑…

    腾讯云 2023年12月9日

联系我们

400-800-8888

在线咨询： QQ交谈

邮件：admin@example.com

工作时间：周一至周五，9:30-18:30，节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。