魔笔平台提供了强大的阿里云 OSS 集成功能,允许用户通过简单的配置,实现对阿里云 OSS 接口的无缝连接和数据交互。本文档将指导您如何创建和使用阿里云 OSS 集成。
功能介绍
魔笔平台的阿里云 OSS 集成功能支持以下特点:
自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。
回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。
高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。
事件相关内容可参考:集成操作事件
使用阿里云 OSS 集成
步骤 1:创建阿里云 OSS 集成
登录魔笔平台,进入管控台。
导航至“资源”->“集成”,点击“创建集成”。
选择“阿里云 OSS”,并填写集成名称及描述。
配置不同环境的阿里云 OSS 集成信息,包括
区域
、Bucket 名称
和访问密钥
等。点击“确定”创建阿里云 OSS 集成。
步骤 2:在应用内部创建集成操作
打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。
选择之前创建的阿里云 OSS 集成作为资源,选择操作类型后会展开该操作类型下的所有参数,配置参数后点击运行获取返回结果。
点击“运行”预览查询效果。
配置面板详解
集成配置
关于阿里云 OSS 请参考什么是对象存储 OSS。
区域:定义了阿里云 OSS 的 Bucket 存储数据的区域。关于 Bucket 的空间地域,可以参考存储空间地域属性。
Bucket 名称:定义了阿里云 OSS 存储空间的名称。关于 Bucket 名称,可以参考存储空间命名
访问密钥:定义了预期发起 OpenAPI 请求所使用的访问密钥,关于访问密钥,可以参考创建AccessKey。
角色 ARN:目标RAM角色的 ARN(Aliyun Resource Name,阿里云资源名称),分片上传时必填。关于创建角色,可以参考创建可信实体为阿里云账号的 RAM 角色。关于查看角色 ARN,可以参考查看 RAM 角色。
通用配置
获取分片上传凭证: 操作类型为
获取分片上传凭证
时,需要填写要上传的目录(为空时默认使用根目录)和访问权限(为空时默认使用集成 Bucket 访问权限)。推荐在传输大文件(超过 5 GB)时,使用分片上传。重要获取分片上传凭证
必须要在集成配置中填写角色 ARN
参数,否则无法使用。请注意目录的命名格式,不要以正斜线/
或反斜线\
开头,不要出现连续的正斜线/
。详情请参考管理目录。获取表单上传:操作类型为
获取表单上传凭证
时,需要填写要上传的目录(为空时默认使用根目录)和访问权限(为空时默认使用集成 Bucket 访问权限)。推荐在传输小文件(不超过 5 GB)时,使用表单上传。重要表单上传不支持上传超过 5 GB 的文件。
获取文件 URL: 操作类型为
获取文件 URL
时,需要填写要获取的文件的完整路径(完整路径不包含 Bucket 名称),如果该文件的访问权限为私有,则根据过期时间参数(为空则默认 300 秒)获取该文件的加签 URL,否则获取该文件的公开 URL。关于文件的权限,可以参考设置Object ACL。- 说明
OSS 集成操作
获取分片上传凭证
与获取表单上传凭证
请与上传组件一起使用以实现将文件上传到阿里云 OSS。重要使用文件上传功能时,请确保您的 Bucket 允许跨域来源。在使用分片上传时,请在暴露 Headers 中设置
Etag
。关于跨域设置,可以参考跨域设置。
回调配置
数据转化:对接口返回的数据进行处理,默认为
return data
,即不进行处理。成功回调:配置接口调用成功时触发的事件。
失败回调:配置接口调用失败时触发的事件。
高级配置
防抖:设置防抖表达式,避免接口的频繁调用。
禁止执行条件:根据条件表达式确定是否执行此集成操作。
手动触发集成
事件触发
在需要触发集成操作的组件中,配置事件处理器。
将动作类型设置为集成操作,并选择相应的集成。
以对象形式填写已配置的参数。
API 触发
若此集成操作的名称为action1
,则在任何可以执行脚本的地方,可以使用action1.trigger()
方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。