检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用:选择调用自定义接口所属的应用。 API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签。如果接口标签未定义,则显示接口的操作名称。 请求类型:API接口的请求类型,系统会自动填入。 参数:接口入参,当有入参时,系统会自动展示,本示例不涉及。
组件内置API 内置API一览表 Studio对象预置API一览表 magno对象预置API一览表 HttpUtils工具类预置API一览表 SafeUtils安全工具类预置API一览表 父主题: 自定义组件开发规范
内置API一览表 表1 内置API一览表 API API说明 init 组件渲染的入口函数,组件自己实现继承,使用推荐模板即可。 render 整个组件渲染的业务逻辑实现入口,组件自己实现继承。 getConnectorProperties 获取Connector对接的配置值,用于查看与Connector相关的信息。
Studio对象预置API一览表 表1 Studio对象预置API一览表 API API说明 registerWidget 定义组件。 registerConnector 定义桥接器。 registerEvents 注册事件,只有通过此API注册后的事件才会在组件的事件列表中展现。
HttpUtils工具类预置API一览表 表1 HttpUtils工具类预置API一览表 API API说明 getCookie 用于获取某个cookie的值。 setCookie 用于设置cookie的值。 getI18n 返回一个Vue18n的实例。 getCsrfToken
magno对象预置API一览表 表1 magno对象预置API一览表 API API说明 savePropertiesForWidget() 用于在开发态中保存当前组件的高级设置属性信息。 savePropertiesForWidget() 该API用于在开发态中,保存当前组件的高级设置属性信息。
SafeUtils安全工具类预置API一览表 表1 SafeUtils安全工具类预置API一览表 API API说明 escapeHtml() 将HTML字符串进行转义。 getSafeUrl() 对外部链接进行xss安全过滤,获取安全的绝对URL地址。 escapeHtml()
桥接器数据类型:桥接器的数据源类型,支持“静态数据”和自定义接口“AstroZero API”。 URL:配置为自定义接口的URL。如何查看自定义接口URL,请参考查看自定义接口。“桥接器数据类型”选择“AstroZero API”时,才显示该参数。 共享数据:是否共享数据。勾选表示某
全局变量,“多区域折线图”组件呈现的数据来源于封装了AstroZero某API接口的数据集,将该接口的入参与全局变量绑定,则“多区域折线图”组件呈现的告警数据会随着全局变量值变化而变化。 如图1所示,也可以不使用“下拉选择框”组件,直接在发布的页面URL末尾加上“?全局变量名=值
结尾。 APIC服务地址:ROMA Connect服务集成APIC的网关地址,配置该值后,可实现调用ROMA Connect的服务API。 服务集成APIC(API Connect,简称APIC)是ROMA Connect的API集成组件,APIC将数据和后端服务以API形式开放
显示该参数。 接口鉴权方式:设置接口鉴权方式,支持API鉴权、AK/SK、API Key和无身份验证。 API鉴权:填写API鉴权信息后,可在连接器中选择其响应参数,作为连接器请求参数的值。 无身份验证:不需要任何验证信息,直接调用接口,通常用于访问一些公开的接口。 AK/SK:
请求类型:请求的类型,如GET、POST。 参数:输入参数,请根据实际请求进行配置。 测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。 转换器:选择新建转换器中创建的
应用:选择调用自定义接口所属的应用。 API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签。如果接口标签未定义,则显示接口的操作名称。 请求类型:API接口的请求类型,系统会自动填入。 参数:接口入参,当有入参时,系统会自动展示。
查询配置:单击“新增查询”,可增加promQL查询,最多只支持添加8条,支持设置变量。 测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。
AstroZero数据源 操作场景 通过调用当前环境AstroZero接口或其他环境AstroZero接口,返回的数据作为数据源。 操作步骤 参考登录AstroCanvas界面中操作,登录AstroCanvas界面。 在主菜单中,选择“数据中心”。 在左侧导航栏中,选择“数据源”。
面,可从下方左侧面板选择字段名、函数或者直接输入函数,如图3。 图3 表达式设置 测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。
图4 设置数据集 应用:选择调用自定义接口所属的应用,本示例选择AstroZero中安装的“告警服务Mock应用”。 此处的“告警服务Mock应用”仅为示例,在实际使用时,选择AstroZero中已安装的一个应用即可。 API接口:API接口的URL,本示例选择“getWarnDetailByStatus”接口。
建项目和页面。 数据中心 数据中心用于对页面的数据源进行集中的配置管理,支持多种数据源,如静态数据、调用AstroZero API接口、ROMA API接口和AstroZero报表等。 数据源管理:新增并管理关系型数据库、DWS、DLI和AstroZero等数据源。 数据集管理:
在进行前台页面开发时,经常要通过桥接器动态调用后台的接口来获取后台数据。在页面实际开发过程中,可能后台接口还未开发完成,这时可通过修改桥接器使用静态数据来进行调测。但是当组件较多时,用户逐个修改组件的桥接器配置会过于繁琐,可直接将桥接器配置为调用后台接口,在“项目设置”中打开“启用模拟数据”开
面开发时,经常要调用后台数据,例如购物车中用户的ID,订单编号,商品信息等,这时需要通过桥接器动态调用后台接口获取后台数据。通过AstroCanvas预置的桥接器模板,您可以自定义桥接器。自定义桥接器时,需要先下载桥接器模板,根据组件的数据结构,对桥接数据进行对接和改造。如何自定义桥接器,请参见自定义桥接器。