检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求
签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与请求的Authorization头中签名是否一致来校验API请求是否合法。 同一个环境中一
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 获取API的请求消息 在调用API前,您需要向API管理者获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安全认证方式,还要获取相关的请求认证信息:
开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”,选择需要下线的环境。
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
(可选)导入到API服务,将已设计的接口导入API服务。 (可选)可视化设计API文件,对接口可视化设计。 (可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。 勾选需要配置SLA的API,单击“批量配置SLA”。 (可选)Mock调测。 开启“Mock”会自动生成Mock服务地
函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在ROMA API中创建自定义的函数认证,ROMA API通过此函数对接后端认证系统,获取后端服务的访问授权。
务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置 使用一些基础的API编排集成能力 前提条件
API设计文件以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 根据需要导出文件的格式,单击,选择“导出YAML/导出JSON”导出文件。 Mock调测 对API设计文件的接口地址进行调测。 在页面中单击API设计文件名称,进入API编辑页面。
PI产品从API目录中下架。 选择需要下架的API产品,单击产品名称。 选择下架版本,单击“下架”。 填写下架申请,单击“确定”。 审核申请通过后,产品下架成功。 克隆新版本 创建产品新版本,同步产品基本信息和API,可自行添加API。 选择需要克隆的API产品,单击产品名称。 选择克隆版本,单击“克隆新版本”。
API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
/账号名。 IP地址 单击“增加IP地址”,输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“限制类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别可以配置最多100条。 账号名 输入需要允许或者禁止访问API的IAM账号名。IAM账号名的获取方式参考获取账号名。
具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。 更新应用
选择服务和API后,单击“确定”。 解绑API 将策略与API解绑。 单击策略名称,进入策略详情。 单击“解绑”。 批量解绑:选择需要解绑的API,在列表上方单击“解绑”。 单个解绑:在需要解绑的API所在行,单击“解绑”。 在弹框中,单击“确定”。 父主题: 策略管理
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题: API消费
应用管理 创建应用 管理应用 父主题: 管理中心
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费