CreateImageSplicingTask_智能媒体管理_API文档

2020-09-30

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

imm:CreateImageSplicingTask	Create	Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}	无	无

请求参数

字段名称	字段详情
ProjectNamestring	项目名称，获取方式请参见创建项目。示例值:test-project参考取值来源: CreateProject UpdateProject ListProjects
Sourcesarray<object>	输入图片列表，拼接顺序为输入列表 URI 顺序。子级条数 >= 1
TargetURIstring	输出图片存储的 OSS 地址。展开详情示例值:oss://examplebucket/outputImage.jpg参考取值来源: CreateImageToPDFTask
ImageFormatstring	输出图片的压缩格式。可取值如下：展开详情示例值:jpg枚举值:jpgpngwebp
Qualityinteger<int64>	输出图片压缩质量，仅对 jpg 和 webp 图片格式生效。取值范围为 0~100，默认值为 80。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:80
Directionstring	图片拼接方法。可取值如下：展开详情示例值:vertical
ScaleTypestring	被拼接图片在对齐宽度或高度时的缩放方式。可取值如下：展开详情示例值:stretch
Aligninteger<int64>	被拼接图片宽或高需要对齐的像素值。取值范围为 1~4096。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:192
Paddinginteger<int64>	拼接后图片中子图的间隔，默认值为 0，单位为 px。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:2
Margininteger<int64>	拼接后图片的空白边缘，默认值为 0，单位为 px。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:2
BackgroundColorstring	参数`Padding`与`Margin`对应区域的填充颜色，支持`#FFFFFF`形式与预设的`red`、`alpha`等关键字。示例值:red
UserDatastring	用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。示例值:test-data
CredentialConfigCredentialConfig	链式授权配置对象，一般留空即可。展开详情
Tagsobject	自定义标签，用于对异步任务进行搜索、过滤。示例值:{ "User": "Jane" }
NotificationNotification	消息通知对象，支持多种消息中间件，消息格式详情请见异步通知消息格式，请选择其中一种方式接收消息，使用方式如下所示：展开详情

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:94D6F994-E298-037E-8E8B-0090F27*****
EventIdstring	事件 ID。示例值:10C-1R6p7Km0H5Ieg38LKXTIvw*****
TaskIdstring	任务 ID。示例值:ImageSplicing-537cc157-7645-444a-a631-c8db4d02*****

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-04-03	删除请求参数NotifyTopicName 删除返回参数
	2023-03-09	新增请求参数Notification 新增返回参数
	2022-08-16	删除请求参数NotifyEndpoint
	2022-07-20	新增请求参数Margin
	2022-07-19	新增OpenAPI，创建图片拼接任务

相关示例