检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
删除签名密钥 功能介绍 删除指定的签名密钥。签名密钥绑定了API时无法删除,需要先解除与API的绑定关系后删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
配置跨域访问API 概述 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类:简单请求和非简单请求。 简单请求:同时满足以下
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
断路器插件说明 概述 断路器是ROMA Connect在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
设置APP的访问控制 功能介绍 设置客户端配置的访问控制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2
查询APP Code列表 功能介绍 查询App Code列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances
查询应用配置列表 功能介绍 查询应用配置列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{
API管理(V1) 创建API 修改API 删除API 查询API详情 查询API列表 批量删除API 批量发布或下线API 调试API 父主题: 服务集成API(V1)
创建函数API 概述 ROMA Connect支持把自定义函数定义为后端服务,把函数的能力以API的形式对外开放。 前提条件 如果后端服务需要使用签名密钥请求发送方进行认证,请提前创建签名密钥。 部署并发布后端服务时,如果需要使用自定义认证方式进行API的安全认证,请提前创建自定义认证
创建数据API 概述 ROMA Connect支持把数据源定义为后端服务,实现从数据源中读写数据,并以API的形式对外开放。 前提条件 ROMA Connect已接入数据源,具体请参考接入数据源。 如果后端服务需要使用签名密钥对请求发送方进行认证,请提前创建签名密钥。 部署并发布后端服务时
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey
跨域资源共享插件说明 概述 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见配置跨域访问API。 跨域资源共享插件为跨域访问提供指定预检请求头和响应头
配置API的访问控制 访问控制可控制访问API的IP地址和账户,保护后端服务。您可以创建访问控制策略,允许/禁止某个IP地址或账号访问绑定策略的API。 访问控制策略和API本身是相互独立的,只有将API绑定访问控制策略后,访问控制策略才对API生效。 约束与限制 同一个API在同一个环境中只能绑定一个相同限制类型的访问控制策略
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? 添加x-stage请求头后即可访问,值为环境名。 父主题: 服务集成
绑定签名密钥 功能介绍 签名密钥创建后,需要绑定到API才能生效。 将签名密钥绑定到API后,则服务集成请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥