描述
列出项目下的文件格式转换任务。
请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Project | String | 是 | 项目名,ALL 表示全部 |
Action | String | 是 | ListOfficeConversionTask |
Marker | string | 否 | 设定结果从 Marker 之后按字母排序的第一个开始返回, 可以不设定,不设定时从头开始返回 |
MaxKeys | int | 否 | 限定此次返回任务的最大数, 如果不设定,默认为100,MaxKeys 取值不能大于 100 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户 |
Tasks | Array | 任务 FormatConvertTask 的数组 |
NextMarker | String | 表示下一次 List 可以以此为 Marker,将未返回的结果返回, 当未全部返回时,才有此返回参数 |
数据类型FormatConvertTask
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务 ID |
Status | String | 任务状态:
|
Percent | Integer | 任务进度百分比,0-100 的整数 |
PageCount | Integer | 页数 |
SrcUri | String | 源数据的存储位置, 例如 OSS 资源”oss://bucket1/object” |
TgtType | String | 转换输出目标文件类型,目前支持 JPG 格式 |
TgtUri | String | 转换输出内容到目标位置, 例如 OSS 桶的指定前缀”oss://bucket1/imm-format-convert-tgt/session123/“ |
ImageSpec | String | 输出图片的格式,缺省为 1024 像素, 长宽不同时按照最先到达边界的条件进行等比例控制 |
NotifyTopicName | String | 异步反向通知的 TopicName,不存在则为空 |
NotifyEndpoint | String | 异步反向通知的 Endpoint,不存在则为空 |
ExternalID | String | 任务的外部标签,不存在则为空 |
CreateTime | String | 任务创建时间 |
FinishTime | String | 任务结束时间,当任务状态为 “Finished” 时,才是真实的值。否则,内容为空。 |
示例
请求示例
POST https://imm.cn-shanghai.aliyuncs.com
?Action=ListOfficeConversionTask
&Project=test
...
此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API。
成功返回示例
{
"RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514",
"Tasks":[
{
"TaskId": "23468948-33EA-28A0-CA35-452ACE867326",
"Status": "Finished",
"Percent": 100,
"PageCount": 20,
"SrcUri":"oss://bucket1/test.pptx",
"TgtType", "jpg",
"TgtUri", "oss://bucket1/imm-format-convert-tgt/session123/",
"ImageSpec", "1024",
"NotifyTopicName ":"",
"NotifyEndpoint ":"",
"ExternalID", "aaa",
"CreateTime", "2018-07-20T06:51:17.5Z",
"FinishTime", "2018-07-20T06:51:17.5Z"
},
{
"TaskId": "56368948-44EA-28AC-BA37-122ACE867335",
"Status": "Finished",
"Percent": 100,
"PageCount": 20,
"SrcUri":"oss://bucket1/test.docx",
"TgtType", "jpg",
"TgtUri", "oss://bucket1/imm-format-convert-tgt/session231/",
"ImageSpec", "1024",
"NotifyTopicName":"",
"NotifyEndpoint":"",
"ExternalID", "",
"CreateTime", "2018-07-20T06:51:17.5Z",
"FinishTime", "2018-07-20T06:51:17.5Z"
}
]
"NextMarker": ""
}
若在使用中有疑问,请参考 FAQ,或者进入 钉钉用户群 实时交流。
原创文章,作者:网友投稿,如若转载,请注明出处:https://www.cloudads.cn/archives/33481.html