使用HTTPS并用域名访问
1.绑定域名步骤 用户将自己的域名绑定到API网关需要以下两步操作：在API网关控制台将域名绑定到API分组上；将自己的域名通过CNAME方式解析到API网关提供的二级域名上，进行业务流量切换。1.1 绑定域名 1.进入API网关控制台，点击左边菜单的...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
IP访问控制插件
说明 WAF会将他收到的请求的源IP加入到X-Forwarded-For头的最后发送给API网关，API网关去判断X-Forwarded-For头中的这个值就可以。这种情况建议用户使用"XFF:1"来判断WAF前一跳的IP地址。resource字段填写格式为“XFF:index”，index的值为...
函数计算
函数计算是一个事件驱动的服务（函数概述）。API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。...2.2 添加API 说明 在API网关控制台上的详细操作步骤，详见快速入门中的 创建后...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
Zookeeper
本文将介绍API网关集成Zookeeper访问微服务后端的原理，以及如何创建、发布并调用服务发现类型的API。1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建...
后端签名插件
签名计算方法步骤如下：API网关需要从发送给后端的HTTP请求中提取出关键数据，组合成一个签名串，生成的签名串的格式如下：HTTPMethod Content-MD5 Headers PathAndParameters 以上4个字段构成整个签名串，字段之间使用 间隔，如果Headers...
混合云API集中管理
主要场景如下：场景一：阿里云跨region内网VPC调用API网关 场景二：本地数据中心IDC机房内网调用APi网关 场景三：API网关内网访问部署在IDC机房的后端服务 场景一 阿里云跨region内网VPC调用API网关 本场景的客户端为北京vpc-3专有网络下的...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
产品简介
API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...
应用场景
API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...
JWT认证插件
Json Web Token(RFC7519),是一种便捷的可用于网关进行请求认证的鉴权方案，API 网关 可以通过托管用户的 Public JWK 实现对请求进行JWT认证，并将 claims 作为后端参数转发给后端，以方便用户简化开发后端应用的开发。本文主要是JWT认证...
VPC下的用户使用API网关有什么要求？
需要保证 API 网关可以与相应底层服务通信，所以 VPC 下的用户需要使用 EIP 或 负载均衡，以便 API 网关调用您的底层服务。
VPC授权连通性测试
VPC授权连通性测试用于验证API网关实例到您授权的VPC中实例的网络连通性，有助于将API调试阶段由于网络连通问题引发的调用失败提前暴露。本文将重点介绍VPC授权连通性测试功能，以及如何根据排错引导解决连通性测试失败的情况。1.概述 VPC...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
使用VPC内资源作为API的后端服务
可作为API网关后端服务的VPC内资源主要包括ECS以及CLB，本文主要讲述如何创建一个高可用的后端服务。概述 使用阿里云专有网络VPC，可以构建出一个隔离的网络环境，并可以自定义IP地址范围、网段、路由表和网关等。API网关也支持您部署在专...
跨域设置
本文主要介绍需要在 API 网关中如何进行双网关跨域设置。说明 只有管理员角色才可以进行跨域设置，如何配置角色权限请联系蚂蚁技术支持团队。添加 workspace 登录 API 网关控制台。在左侧导航栏单击 全局设置>跨域设置。说明 仅 双网关跨域...
基于Swagger完成API网关与用户CICD流程整合
一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关提供的管理接口进行封装整合。如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1...
后端服务调不通
需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关提供了完整的后端签名验证的方式来做身份认证...
通过日志服务查看API调用日志
appId 调用者应用ID appName 调用者应用名称 clientIp 调用者客户端IP exception 后端返回的具体错信息 exchangeTimestamp 整个请求链路的IO时间点 FrontRequestStart：API网关开始接收到客户端请求的时间点 FrontRequestEnd：API网关完成...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
SDK下载及使用指南
若您需要使用 SDK 调用 API 网关开放的 OpenAPI 注意这里的 OpenAPI 是指用于操作 API 网关产品的 API。您需要前往 阿里云 SDK 页面下载 SDK 并查看使用。SDK 下载请前往阿里云 SDK 页面各个语言的“获取各产品 XXX SDK”页面下载，若页面...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
API概览
本产品（智能接入网关/2018-03-13）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可...
外部授权
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。外部授权服务编写须知 您...
支持在线协议吗？如果是线下协议如何操作？
支持在线协议，在开通 API 网关服务时，需要签订使用协议。线下协议需告知 API 网关产品经理和相关法务。
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
错误代码表
API网关错误码表。1.API网关错误码表（VPC实例）本章节的错误代码表适用于 VPC共享实例 和 VPC专享实例。当客户端收到的应答中 X-Ca-Error-Code 头不为空，表示应答码由API网关产生，错误码由一个6位长度的字符描述，请参考下表，而 X-Ca-...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
- 产品推荐
- 这些文档可能帮助您