CreateOfficeConversionTask_智能媒体管理_API调试-阿里云OpenAPI开发者门户

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 CreateOfficeConversionTask 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
执行完成后，使用 GetOfficeConversionTask 接口查询返回的 TaskId，可以查看任务执行结果。任务执行信息只保存 7 天，请及时获取任务执行信息，您也可以使用通知机制，传入 NotifyTopicName 和 NotifyEndpoint，及时通知任务执行信息。

请求参数

字段名称	字段详情
Projectstring	项目名称。示例值:immdoctest
SrcUristring	源数据的存储位置。展开详情示例值:oss://bucket1/object
TgtTypestring	转换输出的目标文件类型。包括如下选项：展开详情示例值:vector
TgtUristring	转换后输出内容的目标位置，建议 TgtUri 和 SrcUri 在同一个 OSS Bucket 中，便于权限管理。展开详情示例值:oss://bucket1/imm-format-convert-tgt/session123/
NotifyTopicNamestring	异步反向通知的 TopicName。示例值:topic1
NotifyEndpointstring	异步反向通知的 Endpoint，文档转换状态可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通 MNS 服务，新建 topic 和 queue，并配置订阅关系。展开详情示例值:http://1111111111.mns.cn-hangzhou.aliyuncs.com
SrcTypestring	当 OSS 对象没有后缀名时，可以设置此参数。展开详情示例值:doc
StartPageinteger<int64>	文档转换的起始页，默认值为 1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
EndPageinteger<int64>	文档转换的结束页，默认值为 200。如果需要转换所有页，设置此参数为-1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
MaxSheetRowinteger<int64>	表格文档转换的最大行数，默认值为 1000。如果需要转换所有行，设置此参数为-1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
MaxSheetColinteger<int64>	表格文档转换的最大列数，默认值为 100。如果需要转换所有列，设置此参数为-1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
MaxSheetCountinteger<int64>	表格文档转换的最大 Sheet 数。如果需要转换所有 Sheet，设置此参数为-1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:3
SheetOnePageboolean	当 TgtType 设置为 pdf 时，此参数才生效。展开详情示例值:false
ModelIdstring	模型 ID。此参数暂不可用。示例值:无
Passwordstring	文档的打开密码。如果需要转换有密码的文档，请设置此参数。示例值:********
TgtFilePrefixstring	当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。展开详情示例值:aa
TgtFileSuffixstring	当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。展开详情示例值:bb
TgtFilePagesstring	当 TgtType 设置为 jpg、png、pdf 时，此参数才生效。展开详情示例值:1, 2, 100
FitToPagesTallboolean	当 TgtType 设置为 pdf 时，此参数才生效。展开详情示例值:false
FitToPagesWideboolean	当 TgtType 设置为 pdf 时，此参数才生效。展开详情示例值:false
IdempotentTokenstring	注意该参数已下线展开详情示例值:d1fdd246-e187-11e8-9f32-f2801f1b9fd1
PdfVectorboolean	当 PDF 转换为 VECTOR 时，是否使用向量模式，默认值为 false。包括如下选项：展开详情示例值:false
Hidecommentsboolean	当 WORD、PPT 转换为 VECTOR、JPG、PNG 时，是否隐藏批注和应用修订，默认值为 false。包括如下选项：展开详情示例值:false
DisplayDpiinteger<int32>	当源数据类型转换为 JPG、PNG 时，此参数才生效。展开详情示例值:1024
UserDatastring	用户自定义数据，在 mns 通知中原样返回。示例值:{"fileid": "123"}

请求说明

MNS 通知 请求参数中如果设置了 NotifyTopicName 和 NotifyEndpoint 支持 MNS 事件通知，则智能媒体管理会为您返回异步通知，例如文档转换的页数，通知的消息格式为：

转换成功消息

{
    "events": [
        {
            "eventName": "FormatConvertJob:JobFinished",
            "eventSource": "acs:imm",
            "eventTime": "2020-11-11T06:51:17.35Z",
            "imm": {
                "taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",
                "code": "NoError",
                "pageCount": "32",
                "percent": "100"
            }
        }
    ]
}

转换失败消息

{
    "events": [
        {
            "eventName": "FormatConvertJob:JobError",
            "eventSource": "acs:imm",
            "eventTime": "2020-11-11T06:51:17.35Z",
            "imm": {
                "taskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b",
                "code": "FailedToDownloadSrcFile",
                "pageCount": "0",
                "percent": "0"
            }
        }
    ]
}

返回参数

字段名称	字段详情
Statusstring	任务运行状态。包括如下选项：展开详情示例值:Running
TaskIdstring	任务 ID。展开详情示例值:formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd169b
RequestIdstring	当次请求的 Request ID。示例值:FF3B7D81-66AE-47E0-BF69-157DCF187514
Percentinteger<int32>	任务进度的百分比。当前只有 0 和 100 两个结果。展开详情示例值:0
CreateTimestring	任务的创建时间。示例值:2020-11-11T06:51:17.5Z
TgtLocstring	输出目标文件的位置，和请求参数中的 TgtUri 相同。示例值:oss://bucket1/imm-format-convert-tgt/session123/

变更历史

	变更时间	变更内容概要	操作
	2021-04-09	新增OpenAPI，创建单个文档的转换任务