检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理 下线API 导入导出API 添加SSL证书 添加简易认证凭据 附录:API的Swagger扩展定义 父主题: 服务集成指导
APP认证工作原理 APP认证流程 构造规范请求。 将待发送的请求内容按照与APIC后台约定的规则组装,确保客户端签名、APIC后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTT
删除后端API 功能介绍 在某个实例中删除后端API。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
Connect通过已发布的连接器实例接入自定义数据源,实现对数据源的读写。 前提条件 已完成连接器的线下开发和部署,连接器与ROMA Connect的对接接口开发请参考连接器RESTful接口规范。 已在ROMA Connect中创建连接器。 操作步骤 登录ROMA Connect控制台,在左侧的导航栏选择“资产管理”。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
Integer 后端API状态: 1:待开发 3:开发中 4:已部署 created_time String 后端API创建时间 modified_time String 后端API修改时间 scripts Array of LdApiScript objects 后端API脚本信息 roma_app_name
消息集成开发指导 开发说明 开发准备 MQS连接开发(开源客户端) MQS连接开发(RESTful API)
Integer 后端API状态: 1:待开发 3:开发中 4:已部署 created_time String 后端API创建时间 modified_time String 后端API修改时间 scripts Array of LdApiScript objects 后端API脚本信息 roma_app_name
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
Integer 后端API状态: 1:待开发 3:开发中 4:已部署 created_time String 后端API创建时间 modified_time String 后端API修改时间 scripts Array of LdApiScript objects 后端API脚本信息 roma_app_name
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多 > 下线”。 在下线API弹窗中,选择要下线API的环境,完成后单击“确定”。 父主题: API管理
Connect实例的“服务集成 APIC > API列表”中查看并编辑该发布的API。 支持的动作 接收API调用 配置参数 参数 说明 API名称 填写API的名称,根据规划自定义。该名称会在对应ROMA Connect实例的“服务集成 APIC > API列表”中展示。 安全认证 选择安全认证方式,当前支持以下方式
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
如何调用API 构造请求 认证鉴权 返回结果
参数 是否必选 参数类型 描述 api_type 否 String API类型 data:数据API function:函数API scripts 否 Array of LdApiScriptBase objects API脚本信息列表 表4 LdApiScriptBase 参数 是否必选
导入API 已创建的API产品资产,可以将API导入到资产中。 登录新版ROMA Connect控制台。 在左侧导航栏选择“资产中心>我的资产”。 单击一个API产品类型的资产,并切换到“API资产”页签。 单击“导入api”,弹出“添加API资产”弹窗。 选择“从ROMA中导入”或“外部上传”,进行API导入。
调试API 概述 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“