全部产品
Search

搜索本产品

    智能媒体管理：CreateImageToPDFTask - 创建图片转PDF任务

    文档中心

    智能媒体管理：CreateImageToPDFTask - 创建图片转PDF任务

    更新时间：Dec 11, 2024

    将多张图片转换为单个PDF文件，并保存到指定的OSS文件对象地址。

    接口说明

    • 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
    • 调用该接口前，请确保当前 Region 已经存在可用的项目（Project），详见项目管理。
    • 该接口最大支持输入 100 张图片。
    • 该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    imm:CreateImageToPDFTaskcreate
    *Project
    acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}
      无
    		无

    请求参数

    名称类型必填描述示例值
    ProjectNamestring是

    项目名称，获取方式请参见创建项目。

    		test-project
    Sourcesarray<object>是

    输入图片列表，转换顺序为输入列表 URI 的顺序。

    object是

    输入图片信息。

    URIstring是

    源图片的 OSS 地址。

    OSS 地址规则为 oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。

    支持的图片格式：jpg、jp2、png、tiff、webp、bmp、svg。

    		oss://examplebucket/sampleobject.jpg
    Rotatelong否

    图片旋转角度。可取值如下：

    • 0（默认）
    • 90
    • 180
    • 270
    		90
    TargetURIstring是

    输出 PDF 存储的 OSS 地址。

    OSS 地址规则为 oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的 OSS Bucket 名称，${objectname}为包含文件名称的文件路径。

    		oss://examplebucket/outputDocument.pdf
    UserDatastring否

    用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

    		test-data
    CredentialConfigCredentialConfig否

    如无特殊需求，请保持留空即可。

    链式授权配置。更多信息，请参见使用链式授权访问其他实体资源。

    Tagsobject否

    自定义标签，用于对异步任务进行搜索、过滤。

    		{ "User": "Jane" }
    NotificationNotification否

    消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		EC564A9A-BA5C-4499-A087-D9B9E76E*****
    EventIdstring

    事件 ID。

    		0ED-1Bz8z71k5TtsUejT4UJ16Es*****
    TaskIdstring

    任务 ID。

    		ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****"
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-04-03OpenAPI 入参发生变更查看变更详情
    2023-03-09OpenAPI 入参发生变更查看变更详情
    2022-08-16新增 OpenAPI查看变更详情