查询指定后端实例的端口映射表
查询指定后端实例的端口映射表（自定义路由类型监听）。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM...
使用后端服务提高管理效率
当用户的某个后端服务在测试环境的后端地址A需要修改为后端地址B时，只需要修改该后端服务在测试环境上的后端地址，与之关联的API将会自动更新，用户不需要重新发布，直接调用API就可以指向新的后端地址B；2.当用户的某个后端服务在测试...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建 API
这部分就是在声明前后端API映射关系的。配置常量参数：您可以配置常量参数。您配置的常量参数对您的用户不可见，但是API网关会在中转请求时，将这些参数加入到请求中的指定位置，再传递至后端服务，实现您的后端的一些业务需求。比如您需要...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
API概述
调用客户端API与调用云端API需要使用不同的AppKey和AppSecret来进行身份认证和鉴权。AppKey和AppSecret由生活物联网平台颁发，获取方式如下。App端：您需要从平台获取AppKey和AppSecret，详细操作请参见 创建自有App。云端：您需要从平台...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
新功能发布记录
导入导出API定义 Zookeeper VPC融合实例后端服务支持Zookeeper 全部 Zookeeper App 支持多个密钥对 App 支持多个密钥对 全部 授权管理 2023-09 功能名称 功能描述 发布地域 相关文档 APP支持扩展字段 允许用户为APP配置一个扩展字段，并且...
创建后端服务为HTTP的API
本文将快速引导您如何在API网关中，发布后端服务为HTTP类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是...
API网关灰度发布最佳实践
二、典型场景 API网关后端路由插件支持的灰度分流条件 使用API网关的APP进行灰度：获得授权的APP事实上代表身份不同的API调用者，这种情况下当有两个以上授权APP的时候，可以根据调用者APP将请求转发到不同后端。假设，某个API授权给了多个...
对象存储
本文将快速引导您如何在API网关中，发布后端服务为对象存储（OSS）类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
HTTP API 请求格式
当通过移动网关的 API 测试页面或直接通过 Postman 等非 mPaaS 客户端调用 API 时，可以参考如下格式手动构造对应的 RPC 请求。API 测试页面 API 测试页面中请求参数格式为[{}]。当该 API 后端为 HTTP 服务时，到后端 HTTP 服务 get 请求的...
逻辑流操作
后端调用集成API 后端调用指定的集成API。详情请参考 后端调用集成API。扩展操作 操作 逻辑流类型 说明 写入本地存储 前端逻辑流 向浏览器localStorage或sessionStorage中写入变量。详情请参考 写入本地存储。清除本地存储 前端逻辑流 删除...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
SOFARPC 客户端接入
本文适用于订阅方使用 SOFARPC 作为客户端接入 API 网关。前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并...
错误代码表
请重新订购 B403MI 403 Api Market Subscription invalid API市场订购关系非法 D504RE 504 Backend domain `${Domain}` resolve failed 后端域名解析失败，请核实后端域名解析 D504IL 504 Backend domain `${Domain}` resolve to illegal ...
ApiGateway服务关联角色
背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问用户函数计算的访问权限，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关...
函数计算
API 网关向函数计算传入参数格式：当以函数计算作为 API 网关的后端服务时，API 网关会把请求参数通过一个固定的 Map 结构传给函数计算的入参 event。函数计算通过如下结构去获取需要的参数，然后进行处理。{"path":"api request path",...
跨域资源共享（CORS）
这意味着使用这些API的Web应用程序只能加载同一个域下的资源，除非使用CORS机制（Cross-Origin Resource Sharing 跨源资源共享）获取目标服务器的授权来解决这个问题。上图画的是典型的跨域场景，目前主流浏览器为了用户的安全，都会默认...
第三方鉴权插件
配置了orAppAuth:true参数后，APP验证和第三方鉴权只要有一个成功了，就算鉴权成功。2.6 支持从鉴权服务的应答中提取字段发给后端服务 从鉴权服务返回的应答中提取字段发给后端服务，可以用 authResultPassThrough 来配置发送给后端服务的...
Mock
配置 Mock 在 API 编辑页面-定义API后端服务，来配置 Mock。1.填写 Mock 返回结果 Mock 返回结果，可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如：{"result":{"title":"API 网关 Mock 测试",.} } ...
搭建无服务器应用之手机号归属地查询
定义API后端服务：后端服务类型需选择FunctionCompute；Service和Function填入之前在函数计算中设置好的参数。说明 建议API网关与函数计算选择在同一区域，以免走公网响应时间变长。API网关上设置的超时时间应不小于函数执行的时间，以避免...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
API概览
后端 API 标题 API概述 CreateBackend 创建后端服务 在API网关创建后端服务。DeleteBackend 删除后端服务 删除后端服务。ModifyBackend 修改后端服务 修改后端服务的基本信息如名称，描述，后端服务类型一经创建无法修改。...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
环境管理
在API网关上进行环境管理的时候，您需要做两部分工作：API的后端服务环境：通过设置后端服务，为后端服务的测试、预发、线上环境分别定义不同值，从而当调用API时，API网关可以调用到不同的后端地址。API的前端调用：需要client端显式的...
TCP连接超时时间配置
下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端服务的应答返回给用户的客户端。...
Nacos
8.创建应用并授予API的调用权限 应用（APP）是您调用API服务时的身份，在本例创建API的时候，认证方式选择的是“阿里云APP认证“，因此在API发布后，还需要创建APP，并将APP和API的对应关系建立好，才能够正常访问。具体操作步骤可参考 ...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
SAG APP介绍
智能接入网关SAG（Smart Access Gateway）APP是智能接入网关的软件客户端形态，您在电脑、手机等移动终端安装SAG APP客户端后，可一键连接企业内网。使用场景 企业员工在电脑、手机等移动终端安装SAG APP客户端后，可通过阿里云云连接网CCN...
错误码
说明 关闭 API 或者后端系统集群的安全认证，调试是否调用成功。如果成功，则说明是加签验签的问题，再加上 AK/SK 之后看还是否成功。检查加签的算法类型是否支持，目前仅支持 SHA256 算法。全部错误码 网关结果码 HTTP 状态码 结果信息...
API网关-事件总线服务关联角色
应用场景 用户在创建事件总线类型的后端服务时，API网关会提示用户创建事件总线服务关联角色，在后续操作中，用户在API网关创建后端为事件总线的API并调用，API网关在上传事件到用户的事件总线时需要使用服务关联角色...
API网关的审计事件
DescribeBackendDifferentApis 查询API后端定义不一致的API列表。DescribeBackendInfo 查询后端服务的信息。DescribeBackendList 查询后端服务列表。DescribeConflictApis 查询API定义不一致的API列表。DescribeDeployApiTask 查询发布API...
参数映射与校验规则
API网关会识别前端路径参数并将其映射到后端服务路径上 QueryString:透明传输给后端，保持原始接收到的QueryString的顺序与格式 Header:除一些系统头和以 X-Ca-开头的 Header 以外，网关会透传其余的Header给后端，API网关会使用 ISO-8859-...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
后端签名插件
API绑定后端签名插件后，API 网关向您后端服务请求时会使用这一对Key和Secret对请求内容进行加签处理，您后端服务可以对网关发送过来的请求做对称加签计算，对比网关的签名和服务器端计算的签名是否一致就可以对网关做身份验证。1.什么是后...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
- 产品推荐
- 这些文档可能帮助您