检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
测试”,发送请求。 在“执行结果”处,可查看后端的响应结果。 在“执行历史”处,可查看后端的历史测试记录。单击测试记录,可以将历史测试参数导入到左侧测试参数中,并再次测试。 部署后端。 后端测试完成后,在页面右上角单击“部署”,在确认弹窗中单击“立即部署”,部署后端服务。 发布数据API。
开发规范 API调用认证开发要求 开发工具版本要求: IntelliJ IDEA:2018.3.5或以上版本。 Eclipse:3.6.0或以上版本。 Visual Studio:2019 version 16.8.4或以上版本。 开发语言环境版本要求: Java:1.8.111或以上版本的Java
IAM认证信息错误 用户在调用使用IAM认证的API时,常见如下IAM认证信息错误: Incorrect IAM authentication information: verify aksk signature fail Incorrect IAM authentication
后端服务签名校验开发 开发准备 Java SDK使用说明 Python SDK使用说明 C# SDK使用说明 父主题: 服务集成开发指导
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。
调用开放的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 如果两个API的所属分组、请求方法和请求路径都相同,则调用API
调用开放的API 概述 API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 前提条件 在调用API前,确保您的业务系统所在网络与API的访问域名或地址互通。 若业务系统与ROMA Connect实例在相同VPC内时,可直接访问API。
重置消费组消费进度到指定位置 功能介绍 Kafka实例不支持在线重置消费进度。在执行重置消费进度之前,必须停止被重置消费组客户端。 在停止被重置消费组客户端后,需要经过ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG配置的时间(默认10000毫秒),服务端才认为消费组客户端真正下线。
批量删除资产 功能介绍 批量删除资产。 创建批量删除指定条件的资产的作业任务。 最大支持100个应用和任务。 一个用户同一时刻只能创建一个资产删除作业任务,没有Running状态的作业任务存在。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Exp
批量导出资产 功能介绍 批量导出资产。 创建批量导出指定条件的资产的作业任务。 最大支持100个应用和任务。 一个用户同一时刻只能创建一个资产导出作业任务,请确保当前没有Running状态的资产导出作业任务存在。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
设置用户成员 功能介绍 设置应用的用户成员,为空数组时会清空已有应用成员列表。 设置动作为全量更新非增量更新,应用的成员列表都会替换为当次请求的应用成员列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
配置跨域访问API 概述 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类:简单请求和非简单请求。 简单请求:同时满足以下2个条件的,即为简单请求。
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类:简单请求和非简单请求。 简单请求:同时满足以下2个条件的,即为简单请求。
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。 对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策
创建ACL策略 功能介绍 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 支持根据集成应用编号查询 支持根据集成应用名称查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,服务集成会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API