检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境变量定义
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 service_id Integer 命令所属服务ID。 最小值:0
数据后端:创建数据后端时需要编写执行语句,用于对数据源进行操作。 后端服务签名校验开发:若API在ROMA Connect上绑定了签名密钥,则ROMA Connect向该API的后端服务发送请求时会携带相应的签名信息。该API的后端服务需要集成ROMA Connect提供的SDK,并对请求中的签名信息进行校验。
Connect提供的调试功能对API进行调试,确保API的功能正常。 前提条件 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义API后端服务时配置的“后端超时(ms)”与“重试次数”相乘的值大于30秒,则调试API会超时。 操作步骤
选择要授权的API发布环境。 授权凭据 勾选要授予权限的凭据。 访问参数 为授权的凭据设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 开启绿色通道后,白名单地址中的客户端无需认证即可调用API。 白名单 仅当“绿色通道”开启时需要配置。
身份证明的证书,支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:客户端与服务端连接时,除了客户端需要验证所连接的服务器是否正确之外,服务端也需要验证接入的客户端是否正确。 约束与限制 仅支持添加pem编码格式的SSL证书。
接入数据源 概述 在创建数据API之前,您需要先接入数据源,确保可以正常从数据源读取数据。根据数据源类型的不同,数据源的接入配置有所差异。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时,可直接访问数据源。
填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法,负载通道通过分发算法确定请求被发送到哪台服务器上。 配置通道内服务器。 选择“服务器添加方式”,服务器添加方式在负载通道创建后将不能修改。 选择云服务器:通过选择云服务器的方式添加负载通道服务器。Site实例中,不支持“选择云服务器”方式。
APP认证(双重认证) 同时获取APP认证以及自定义认证所需的认证信息。 IAM认证(Token认证) 获取云服务平台的用户账号密码。 IAM认证(AK/SK认证) 获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。 IAM认证(双重认证) 同时获取IAM认证以及自定义认证所需的认证信息。
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 certificate_ids
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型
自定义后端开发(数据后端) SQL语法 存储过程调用 多个数据源编排 可选参数的使用 父主题: 服务集成开发指导
集成应用 勾选要授予API调用权限的集成应用。 访问参数 为授权的集成应用设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 选择是否开启绿色通道,开启绿色通道后,需要设置白名单和黑名单。 白名单 仅当“绿色通道”开启时需要配置。
集成应用 勾选要授予API调用权限的集成应用。 访问参数 为授权的集成应用设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 绿色通道 选择是否开启绿色通道,开启绿色通道后,需要设置白名单和黑名单。 白名单 仅当“绿色通道”开启时需要配置。
接入数据源 概述 在创建数据API之前,您需要先接入数据源,确保可以正常从数据源读取数据。根据数据源类型的不同,数据源的接入配置有所差异。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时,可直接访问数据源。
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
SQL语法 数据后端与各数据库的SQL语法差异 如果需要把后端服务请求中携带的参数传递给SQL,使用${参数名}的方式传递,其中String类型的参数需要用单引号括起来,int类型的参数则不需要。 如以下示例,name为String类型参数,id为int类型参数。 select *
API分组管理(V1) 创建API分组 修改API分组 删除API分组 查询分组详情 查询分组列表 父主题: 服务集成API(V1)