检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
内置API一览表 表1 内置API一览表 API API说明 init 组件渲染的入口函数,组件自己实现继承,使用推荐模板即可。 render 整个组件渲染的业务逻辑实现入口,组件自己实现继承。 getConnectorProperties 获取Connector对接的配置值,用于查看与
组件内置API 内置API一览表 Studio对象预置API一览表 magno对象预置API一览表 HttpUtils工具类预置API一览表 SafeUtils安全工具类预置API一览表 父主题: 自定义组件开发规范
API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签。如果接口标签未定义,则显示接口的操作名称。 请求类型:API接口的请求类型,系统会自动填入。
HttpUtils工具类预置API一览表 表1 HttpUtils工具类预置API一览表 API API说明 getCookie 用于获取某个cookie的值。 setCookie 用于设置cookie的值。 getI18n 返回一个Vue18n的实例。 getCsrfToken
SafeUtils安全工具类预置API一览表 表1 SafeUtils安全工具类预置API一览表 API API说明 escapeHtml() 将HTML字符串进行转义。 getSafeUrl() 对外部链接进行xss安全过滤,获取安全的绝对URL地址。 escapeHtml()
图2 ROMA连接器配置示例 API接口:API请求路径。 请求类型:请求的类型,如GET、POST。 参数:输入参数,请根据实际请求进行配置。 测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。
Studio对象预置API一览表 表1 Studio对象预置API一览表 API API说明 registerWidget 定义组件。 registerConnector 定义桥接器。 registerEvents 注册事件,只有通过此API注册后的事件才会在组件的事件列表中展现。
图3 按需设置表达式 测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。 单击“格式化”,可对样例报文进行格式化处理。
magno对象预置API一览表 表1 magno对象预置API一览表 API API说明 savePropertiesForWidget() 用于在开发态中保存当前组件的高级设置属性信息。 savePropertiesForWidget() 该API用于在开发态中,保存当前组件的高级设置属性信息
API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签。如果接口标签未定义,则显示接口的操作名称。 请求类型:API接口的请求类型,系统会自动填入。 参数:接口入参,当有入参时,系统会自动展示。
测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。 单击“格式化”,可对样例报文进行格式化处理。
数据中心 数据中心用于对页面的数据源进行集中的配置管理,支持多种数据源,如静态数据、调用AstroZero API接口、ROMA API接口和AstroZero报表等。 数据源管理:新增并管理关系型数据库、DWS、DLI和AstroZero等数据源。
API接口:API接口的URL,本示例选择“getWarnDetailByStatus”接口。 参数:接口入参,当有入参时,系统会自动展示,需要设置参数默认值等。
如何在页面URL参数中给全局变量赋值 如何基于页面级的全局变量实现组件交互中实现的场景是:用户在“下拉选择框”中选择某个告警状态时,通过配置的交互事件将告警状态赋值给全局变量,“多区域折线图”组件呈现的数据来源于封装了AstroZero某API接口的数据集,将该接口的入参与全局变量绑定
设置成功后,可单击“测试API接口”,可进行接口调试。 返回参数:设置接口返回参数,此处的响应参数,可作为连接器请求参数的值。 参数位置:把鉴权信息附加在Query或Header中,请根据实际需求进行配置。“接口鉴权方式”设置为“API Key”时,才会显示该参数。
ROMA连接器数据源 第三方接口或服务通过配置为ROMA连接器的方式,接入外部数据。 新建ROMA连接器数据源 参考登录AstroCanvas界面中操作,登录AstroCanvas界面。 在主菜单中,选择“数据中心”。 在左侧导航栏中,选择“数据源”。 在数据源管理页面,单击“新建数据源
zeroapi 版本 API接口的版本,格式为“x.y.z”。 1.0.0 URL API接口路径, 固定以 /service/{命名空间}__{应用名}/{版本} 开头, 后面接API的具体路径。
桥接器预置 通过桥接器动态调用后台的接口,来获取后台数据展示在页面上,支持使用系统预置的桥接器或自定义桥接器。 预置桥接器 参考登录AstroCanvas界面中操作,登录AstroCanvas界面。 在编辑页面状态下,选中组件,单击组件上方的。 图1 单击数据 在数据类型中,选择“
AstroZero数据源 通过调用当前环境AstroZero接口或其他环境AstroZero接口,返回的数据作为数据源。 新建AstroZero数据源 参考登录AstroCanvas界面中操作,登录AstroCanvas界面。 在主菜单中,选择“数据中心”。 在左侧导航栏中,选择“
组件设置 在组件设置中,查看并管理当前项目中已引用到的所有组件。 组件设置 参考登录AstroCanvas界面中操作,登录AstroCanvas界面。 在AstroCanvas界面的项目列表中,单击已创建的项目,进入项目。 在主菜单中,选择“项目设置”,进入项目设置页面。 参考设置项目锁中操作