Mock
配置 Mock 在 API 编辑页面-定义API后端服务，来配置 Mock。1.填写 Mock 返回结果 Mock 返回结果，可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如：{"result":{"title":"API 网关 Mock 测试",.} } ...
逻辑流操作
后端调用集成API 后端调用指定的集成API。详情请参考 后端调用集成API。扩展操作 操作 逻辑流类型 说明 写入本地存储 前端逻辑流 向浏览器localStorage或sessionStorage中写入变量。详情请参考 写入本地存储。清除本地存储 前端逻辑流 删除...
ApiGateway服务关联角色
背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问用户函数计算的访问权限，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关...
第三方鉴权插件
1.概述 API网关在调用API后端服务之前将先调用用户的鉴权服务，收到鉴权服务的鉴权成功应答后才会继续调用后端服务，否则给客户端返回鉴权失败的应答。第三方鉴权插件支持的功能如下：允许用户自定义发送给鉴权服务的请求参数；允许用户将...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
搭建无服务器应用之手机号归属地查询
定义API后端服务：后端服务类型需选择FunctionCompute；Service和Function填入之前在函数计算中设置好的参数。说明 建议API网关与函数计算选择在同一区域，以免走公网响应时间变长。API网关上设置的超时时间应不小于函数执行的时间，以避免...
TCP连接超时时间配置
下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端服务的应答返回给用户的客户端。...
API网关-事件总线服务关联角色
应用场景 用户在创建事件总线类型的后端服务时，API网关会提示用户创建事件总线服务关联角色，在后续操作中，用户在API网关创建后端为事件总线的API并调用，API网关在上传事件到用户的事件总线时需要使用服务关联角色...
名词解释
API定义 API服务方创建API时，设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则...
魔笔如何区分使用前端还是后端逻辑流
参考文档：逻辑流分类 前端逻辑流：在页面中操作当前内存实体。变更内存实体，而不存在实体更新。页面实体数据变更触发页面更新。涉及到页面操作（显示页面，显示消息）。...后端发布API。需要进行账号操作的时候，（登录，注册）。
API分组同步
仅VPC后端信息不一致API：其他定义一致，仅VPC后端配置信息不一致的API；定义不一致API：定义不一致的API，不包括仅VPC后端配置信息不同且其他定义一致的情况；缺失API：目标分组中存在，但源分组中不存在的API，此类API不在同步范围内；...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
保持客户端源IP
全球加速GA（Global Accelerator）支持保持客户端源IP功能，后端服务器可以通过该功能获取发起访问的客户端源IP。本文为您介绍在不同场景中如何开启保持客户端源IP功能以及后端服务器如何获取客户端源IP。前提条件 您已经在全球加速实例中...
使用前后端链路追踪诊断API错误原因
在前端监控中，即便已知API的请求耗时，也无从知晓准确的网络传输性能、后端服务的调用链路及性能，因而无法快速准确地排查应用API问题。前后端链路追踪功能可以解决此类问题，它会将API请求从前端发出到后端调用的链路串联起来，真实还原...
API网关-微服务集成服务关联角色
应用场景 创建EDAS类型的后端服务/批量导入EDAS类型的后端服务/批量导入EDAS类型的API时，API网关会提示用户创建服务关联角色，用户通过后系统会自动创建一个名称为AliyunServiceRoleForApiGatewayIntegrateWithMicroservices的服务关联...
API 授权
根据您的业务需求，开启 API 授权、配置授权规则，定义授权方接口，并将授权规则应用到 API。功能介绍 API 授权功能允许业务在 MGS 上定义通用的 API 访问授权规则：创建授权 API A 并在网关管理中配置，然后到业务 API B 配置中做关联。...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
API网关流量安全
API网关服务端平均延时过高告警 API网关后端服务器错误率过高告警 API网关请求成功率过低告警 API网关服务端平均延时过高告警 告警ID sls_app_audit_dataflow_at_api_latency 告警名称 API网关服务端平均延时过高告警 版本号 1 类别 云平台...
监听FAQ
根据监听协议和后端服务部署位置不同，获取客户端源IP的方式有所不同：后端服务部署选择 阿里云 时：针对TCP监听协议类型：可选择 自动获取 或 ProxyProtocol 两种方式。其中，IPv6客户端仅支持 ProxyProtocol 方式。针对HTTP或HTTPS监听...
ModifySignature-修改后端签名密钥
接口说明 此功能面向开放 API 的用户 用于修改某个已存在的签名密钥的名称、Key 和 Secret 需要注意，修改立即生效，若该密钥已经绑定 API，后端做验证时请及时调整为针对新签名字符串的验证 该接口调用的 QPS 限制为：单用户 QPS 不超过 ...
VPC授权连通性测试
这三条数据可以唯一确定您的一个业务服务，并授权API网关访问该业务服务，具体可参考 使用VPC内资源作为API的后端服务。2.连通性测试 进入API网关控制台-API管理-VPC授权，根据上述文档创建VPC授权。在操作列表可以看到 连通性测试。点击 ...
后端调用集成API
简介 后端调用集成API操作可用于在当前逻辑流执行环境中通过后端接口调用集成 API。配置属性 后端调用集成API操作属性由以下部分组成，逻辑流通用属性部分请参考 逻辑流操作通用属性：基础属性 示例 说明 API 用于指定调用的目标API。...
D504CO错误码排查
排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考 访问云服务。2、Backend service connect failed `...
API调试及自助排错
请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息，当请求出现错误时API网关会通过响应头...
多级API网关
一个典型的场景是，用户有个负责分发的API，这个API绑定一个后端路由插件和后端签名插件，后端路由插件根据请求的参数来进行后端路由，路由到其他业务API上。1.配置示例 1.1.业务API的配置 一个API如果想被API网关走内网形式的自身调用，...
基于Swagger完成API网关与用户CICD流程整合
API网关致力于让用户专注于后端服务的开发,将认证、流控等通用切面功能交给API网关处理，结合ImportSwagger接口的使用，完成后端服务与API网关的联动，大大减少了API网关的配置过程。同时，让API网关的配置和管理集成到用户的CICD流程中...
如何集成第三方API服务
前提条件 已获取待集成的API接口地址，例如：今日星座运势的API接口地址。操作步骤 集成第三方API服务，可以参考 配置连接器。登录 魔笔。在顶部菜单栏选择 应用管理，在右上角搜索框中输入目标应用，例如 TEST。在指定的应用卡片中单击 ...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
对象存储
本文将快速引导您如何在API网关中，发布后端服务为对象存储（OSS）类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
平台版本
本文简述平台版本及子模块版本的概念 平台版本 平台版本是魔笔平台的版本，魔笔支持多个平台版本，开发者创建应用时候默认会基于魔笔平台的最新版本。当魔笔发布新的特性或修复重要缺陷的时候，会发布...后端运行时版本 后端资源版本。示例：
使用限制
本文描述了API网关的使用限制。...Response Body大小，无限制，但需要在API设置的后端超时时间内返回。函数计算应答限制 事件函数应答Body最大为6MB；后端服务类型HTTP/OSS 海外Region及中国香港不支持新建HTTP/OSS类型后端服务。
2D互动数字人接入指南
了解虚拟数字人开放平台服务端API接入方式 虚拟数字人开放平台的服务端API采用OpenAPI形式对外输出，具体对接方案见：服务端 API 接入篇。2.SDK版本要求 重要 该功能需要升级虚拟数字人开放平台服务端SDK版本至1.0.5及以上。3.调用OpenAPI...
ApiSignatureItem
link">描述 列举API签名密钥信息项的类型 节点名"class="reference-link">节点名 ApiSignatureItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 SignatureId String 后端签名密钥ID...
概述
创建并发布 API：在控制台创建并发布一个 API 服务，指定前端的调用方式和后端的转发方式。创建授权应用：在控制台为需要授权的 API 订阅者应用创建一个授权对象。绑定授权应用：在控制台将授权应用绑定到刚刚创建的 API，完成 API 授权。...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
服务信息是什么
后端服务的调用方式。
后端服务调不通
API网关提供了完整的后端签名验证的方式来做身份认证，使用后端签名机制可以完全避免这种不确定性，我们强烈建议此方法来确认请求来源。使用具体文档：后端签名插件。API网关实例出口IP查看方法：API网关的出口IP请查看分组所在实例的出口...
如何不中断服务更换后端密钥？
如果需要不中断升级您的密钥，那么首先要保证不止一台服务器在支撑您的后端服务，然后您可以按如下步骤操作：要升级您的后端服务，兼容新旧两个 key。在网关中修改您的后端密钥。调整您的后端服务，去除对旧 key 的支持。
- 产品推荐
- 这些文档可能帮助您