CreateImageSplicingTask - 创建图片拼接任务 - 智能媒体管理

将多张图片按设定的规则拼接成一张图片，并保存到指定的OSS文件对象地址。

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
imm:CreateImageSplicingTask	create	*Project `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}`	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称，获取方式请参见创建项目。	test-project
Sources	array<object>	是	输入图片列表，拼接顺序为输入列表 URI 顺序。
	object	是	输入图片信息。
URI	string	是	源图片的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的 OSS Bucket 名称，`${Object}`为包含文件扩展名的文件完整路径。支持的图片格式：jpg、png。	oss://examplebucket/sampleobject.jpg
Rotate	long	否	图片旋转角度。可取值如下： 0（默认） 90 180 270	90
TargetURI	string	是	输出图片存储的 OSS 地址。 OSS 地址规则为 oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的 OSS Bucket 名称，${objectname}为包含文件名称的文件路径。	oss://examplebucket/outputImage.jpg
ImageFormat	string	否	输出图片的压缩格式。可取值如下： jpg（默认） png webp	jpg
Quality	long	否	输出图片压缩质量，仅对 jpg 和 webp 图片格式生效。取值范围为 0~100，默认值为 80。	80
Direction	string	否	图片拼接方法。可取值如下： vertical（默认）：垂直方向拓展，所有被拼接图片需要对齐宽度。 horizontal：水平方向拓展，所有被拼接图片需要对齐高度。	vertical
ScaleType	string	否	被拼接图片在对齐宽度或高度时的缩放方式。可取值如下： fit（默认）：缩放并不保留黑边（仅等比缩放）。 stretch：拉伸以填满。	stretch
Align	long	否	被拼接图片宽或高需要对齐的像素值。取值范围为 1~4096。当参数 Direction 取值为`vertical`时，此参数表示对齐宽度的像素值。当参数 Direction 取值为`horizontal`时，此参数表示对齐高度的像素值。说明若不填写此参数（默认），则默认与拼接的第一张图片的宽或高一致。	192
Padding	long	否	拼接后图片中子图的间隔，默认值为 0，单位为 px。	2
Margin	long	否	拼接后图片的空白边缘，默认值为 0，单位为 px。	2
BackgroundColor	string	否	参数`Padding`与`Margin`对应区域的填充颜色，支持`#FFFFFF`形式与预设的`red`、`alpha`等关键字。	red
UserData	string	否	用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。	test-data
CredentialConfig	CredentialConfig	否	链式授权配置。更多信息，请参见使用链式授权访问其他实体资源。
Tags	object	否	自定义标签，用于对异步任务进行搜索、过滤。	{ "User": "Jane" }
Notification	Notification	否	消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。

返回参数

名称	类型	描述	示例值
	object	图片拼接结果。
RequestId	string	请求 ID。	94D6F994-E298-037E-8E8B-0090F27*****
EventId	string	事件 ID。	10C-1R6p7Km0H5Ieg38LKXTIvw*****
TaskId	string	任务 ID。	ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****

示例

正常返回示例

JSON格式

{
  "RequestId": "94D6F994-E298-037E-8E8B-0090F27*****",
  "EventId": "10C-1R6p7Km0H5Ieg38LKXTIvw*****",
  "TaskId": "ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****"
}

错误码

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

变更历史

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