平台版本
本文简述平台版本及子模块版本的概念 平台版本 平台版本是魔笔平台的版本，魔笔支持多个平台版本，开发者创建应用时候默认会基于魔笔平台的最新版本。当魔笔发布新的特性或修复重要缺陷的时候，会发布新的平台版本，您可以根据需要升级应用...
ApiGateway服务关联角色
背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问用户函数计算的访问权限，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关...
Mock
配置 Mock 在 API 编辑页面-定义API后端服务，来配置 Mock。1.填写 Mock 返回结果 Mock 返回结果，可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如：{"result":{"title":"API 网关 Mock 测试",.} } ...
ALIYUN:ApiGateway:Api
ALIYUN:ApiGateway:Api类型用于创建API。语法 {"Type":"ALIYUN:ApiGateway:Api","Properties":{"ErrorCodeSamples":List,"Description":String,"ServiceConfig":Map,"SystemParameters":List,"ServiceParameters":List,...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
环境管理
在API网关上进行环境管理的时候，您需要做两部分工作：API的后端服务环境：通过设置后端服务，为后端服务的测试、预发、线上环境分别定义不同值，从而当调用API时，API网关可以调用到不同的后端地址。API的前端调用：需要client端显式的...
自定义事件源API网关
步骤四：创建应用及对API授权 在 API网关控制台 的左侧导航栏，选择 调用API>应用管理。在 应用列表 页面，单击右上角的 创建APP，然后在 创建应用 对话框设置应用的名称和描述，单击 确定。回到 API列表 页面，找到 步骤三：创建API 中...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
通过注册方式创建API
调用后端服务过程中如果超过了设定的 服务超时 时间，则调用API时会由于后端服务调用超时报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见 查看及管理运维监控API。请求参数 参数名 对外开放的参数，即用户访问API...
断路器插件
3#判断时间窗口，合法值为10~90秒 openTimeoutSeconds:3 errorThreshold:90#错误阈值 timeoutThreshold:90#后端超时阈值 errorThresholdByPercent:20#用于控制错误阈值的百分比 timeoutThresholdByPercent:20#用于控制后端超时请求的百分比...
版本控制
版本控制是针对云盒Bucket的数据保护功能。开启版本控制后，针对数据的覆盖和删除操作将会以历史版本的形式保存下来。您在错误覆盖或者删除对象（Object）后，能够将Bucket中存储的Object恢复至任意时刻的历史版本。前提条件 仅 华东1...
路径匹配规则
说明 如果需要参数匹配中的参数透传到服务后端，那么在网关控制台配置 API 时，后端服务的请求路径必须为空（下图红框处），若填写了后端服务请求路径，后端服务会以绝对匹配的方式去请求此路径。例如：后端请求路径填写了/user/{name}，...
后端内网域名解析（仅专享实例）
后端内网域名指的是在API网关中配置的后端服务地址。当后端服务地址为内网域名时，API网关提供实例级别的后端服务内网域名解析。概述 例如，后端服务使用的内网域名是通过 PrivateZone 解析时，解析只能在客户指定的VPC内生效，API网关不在...
概述
2.支持插件列表 目前API网关支持下列插件，请单击链接查看：流量控制 IP访问控制 参数访问控制 后端签名插件 JWT认证插件 CORS（跨域资源访问）Caching（缓存）Routing（后端路由）错误码映射 断路器（仅专享实例可用）第三方鉴权插件（仅...
概述
API 接到请求后就会通过 API 网关将请求转发给后端服务应用，实现服务调用。本文将快速引导您如何使用 API 网关产品。角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外...
ModifyBackendModel-修改后端模型
修改后端服务在环境上的定义，修改后，使用该后端服务并发布在此环境上的API的后端地址都会批量更新，无需手动发布。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
ModifySignature-修改后端签名密钥
接口说明 此功能面向开放 API 的用户 用于修改某个已存在的签名密钥的名称、Key 和 Secret 需要注意，修改立即生效，若该密钥已经绑定 API，后端做验证时请及时调整为针对新签名字符串的验证 该接口调用的 QPS 限制为：单用户 QPS 不超过 ...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
魔笔如何区分使用前端还是后端逻辑流
参考文档：逻辑流分类 前端逻辑流：在页面中操作当前内存实体。变更内存实体，而不存在实体更新。页面实体数据变更触发页面更新。涉及到页面操作（显示页面，显示消息）。...后端发布API。需要进行账号操作的时候，（登录，注册）。
DeleteSignature-删除后端签名密钥
接口说明 此功能面向开放 API 的用户 此功能效果是删除已经存在的后端签名密钥 调用该接口时，若要删除的密钥已经绑定了 API，则不能删除。需先解除绑定关系，再调用该接口操作删除 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
DescribeSignatures-查询后端签名密钥列表
接口说明 此功能面向开放 API 的用户 用于查询某 Region 下的后端签名密钥列表，Region 为系统参数 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
更新 VPC 授权信息后如果有关联 API 存在，会自动更新 API 的元定义 true Refresh boolean 否 刷新 VPC 授权 说明 若您的 VPC 资源实例 ID 发生变化，但 IP 地址未变，勾选后可进行刷新授权 false VpcTargetHostName string 否 后端授权的 ...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
Nacos
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例 部署Nacos服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Nacos作为服务的注册中心，可以接收微服务实例的注册请求，并...
开通IPv6
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例分配...
API网关流量安全
API网关后端服务器错误率过高告警 告警ID sls_app_audit_dataflow_at_api_err_rate 告警名称 API网关后端服务器错误率过高告警 版本号 1 类别 云平台、阿里云、流量安全、API网关流量安全 作用 监控API网关中API请求的后端服务器错误率。...
TCP连接超时时间配置
下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端服务的应答返回给用户的客户端。...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API网关-事件总线服务关联角色
应用场景 用户在创建事件总线类型的后端服务时，API网关会提示用户创建事件总线服务关联角色，在后续操作中，用户在API网关创建后端为事件总线的API并调用，API网关在上传事件到用户的事件总线时需要使用服务关联角色...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
逻辑流操作
后端调用集成API 后端调用指定的集成API。详情请参考 后端调用集成API。扩展操作 操作 逻辑流类型 说明 写入本地存储 前端逻辑流 向浏览器localStorage或sessionStorage中写入变量。详情请参考 写入本地存储。清除本地存储 前端逻辑流 删除...
API网关-微服务集成服务关联角色
应用场景 创建EDAS类型的后端服务/批量导入EDAS类型的后端服务/批量导入EDAS类型的API时，API网关会提示用户创建服务关联角色，用户通过后系统会自动创建一个名称为AliyunServiceRoleForApiGatewayIntegrateWithMicroservices的服务关联...
后端调用集成API
简介 后端调用集成API操作可用于在当前逻辑流执行环境中通过后端接口调用集成 API。配置属性 后端调用集成API操作属性由以下部分组成，逻辑流通用属性部分请参考 逻辑流操作通用属性：基础属性 示例 说明 API 用于指定调用的目标API。...
后端路由
backend:后端描述，与API网关的Swagger标准保持一致，后端在原有API的后端上覆盖backend配置后处理，如果覆盖后的backend不完整，会提示客户端 X-Ca-Error-Code:I504RB，当看到这个错误时，请检查自己的backend配置是否完整，关于Backend...
CreateBackend-创建后端服务
在API网关创建后端服务。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中...
API网关灰度发布最佳实践
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
如何集成第三方API服务
前提条件 已获取待集成的API接口地址，例如：今日星座运势的API接口地址。操作步骤 集成第三方API服务，可以参考 配置连接器。登录 魔笔。在顶部菜单栏选择 应用管理，在右上角搜索框中输入目标应用，例如 TEST。在指定的应用卡片中单击 ...
插件数据集
API网关目前在JWT认证插件中支持了插件数据集的使用，后续会在IP访问控制、参数访问控制、后端路由等插件中均支持插件数据集能力。3.插件数据集的特性 API网关提供的插件数据集方便用户动态修改插件中的配置数据，插件数据集具体具备以下...
- 产品推荐
- 这些文档可能帮助您