API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
混合云API集中管理
主要场景如下：场景一：阿里云跨region内网VPC调用API网关 场景二：本地数据中心IDC机房内网调用APi网关 场景三：API网关内网访问部署在IDC机房的后端服务 场景一 阿里云跨region内网VPC调用API网关 本场景的客户端为北京vpc-3专有网络下的...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
使用VPC内资源作为API的后端服务
可作为API网关后端服务的VPC内资源主要包括ECS以及CLB，本文主要讲述如何创建一个高可用的后端服务。概述 使用阿里云专有网络VPC，可以构建出一个隔离的网络环境，并可以自定义IP地址范围、网段、路由表和网关等。API网关也支持您部署在专...
概述
API 网关是一个 API 服务管理平台。企业可以在 API 网关产品上将自己的业务服务创建发布为一个 API，并对外授权给外部的合作伙伴。合作伙伴系统即可向 API 网关产品上的 API 发动调用请求。API 接到请求后就会通过 API 网关将请求转发给后...
API 网关服务等级协议（SLA）
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
WAF接入配置
本文主要介绍如何配置WAF，对API网关上发布的API进行增强安全防护。1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP ...
API网关-事件总线服务关联角色
本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...
基于Swagger完成API网关与用户CICD流程整合
如何将标注的Swagger导入到API网关是我们本章节的重点.2.5.1 基于API网关的Swagger扩展 API网关为了便于用户体验API网关的能力，支持将原生Swagger导入到API网关中。通过这种方式，API网关会自动创建基于Swagger的所有API，并且其默认后端...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
通过日志服务查看API调用日志
API网关 和 日志服务 实现无缝集成，通过日志服务您可以进行实时日志查询、下载、多维度统计分析等，您也可以将日志投递到 OSS 或者 MaxCompute。日志服务每个月前500MB免费，具体价格请参照：日志服务定价。1 功能简介 1.1 日志在线查询 ...
后端服务调不通
需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关提供了完整的后端签名验证的方式来做身份认证...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
函数计算内网访问API网关
本文介绍在函数计算中如何通过VPC访问API网关，包括两种情况：在同一Region，以及在跨Region情况下如何访问。1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
产品简介
API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...
概述
协议转换 API 网关不仅是一个简单的反向代理服务，同时还提供协议转换的能力，支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关，但是仅 Java 语言支持使用高级功能，比如服务端签名校验、数据加解密等，其他语言目前只能...
API报警设置
您可以通过云监控来对发布在API网关上的API配置报警，以便随时了解API服务运行情况，保障服务的稳定性。1.关联资源 API网关监控报警功能可以满足您多样化的业务需求，监控报警的指标包括：HttpStatusCode API响应时间 API总体请求次数 流入...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
如何获取错误信息
BBAF-EFB340E0A5AF/API网关返回的错误消息，当请求出现错误时API网关会通过响应头将错误消息返回给客户端 X-Ca-Error-Message:Invalid Parameter Required `field1`/API网关系统错误码，当请求出现错误被网关拦截后，由API网关提供的错误码...
简介
欢迎使用阿里云API网关服务。用户可以使用本文档介绍的API对API网关服务进行相关操作。请确保在使用这些接口前，已充分了解了API网关产品说明、使用协议和收费方式。术语表 术语 全称 中文 说明 Region 地域 用户开放API，需选择API在API...
SDK下载及使用指南
若您需要使用 SDK 调用 API 网关开放的 OpenAPI 注意这里的 OpenAPI 是指用于操作 API 网关产品的 API。您需要前往 阿里云 SDK 页面下载 SDK 并查看使用。SDK 下载请前往阿里云 SDK 页面各个语言的“获取各产品 XXX SDK”页面下载，若页面...
开通IPv6
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例分配...
应用场景
API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...
API网关为K8s容器应用集群提供强大的接入能力
第二节中的架构设计中，API网关和Kubernetes有两种结合的模式，一种是API网关将请求发送到Ingress Control前的CLB，由Ingress Control将请求路由到Kubernetes对应的节点中，第二种是API网关直接将请求发送到Kubernetes中服务前的CLB，由CLB...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
D504CO错误码排查
1、Backend service connect failed `Timeout connecting to 172.X.X.1:80` 问题原因：API网关和后端服务建立连接超时导致的后端连接失败。解决方案：需要检查您录入的后端服务地址是否正确；如果后端服务在 ECS，请检查安全组设置，是否...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
专享实例
API网关的专享实例可以提供高性能和高SLA保证，更加适合生产环境使用。在您使用专享实例时，使用费用由实例规格使用费用和公网出访流量费用两部分构成。实例规格使用费用 目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
API网关-微服务集成服务关联角色
本文为您介绍API网关-集成微服务（ApiGateway-IntegrateWithMicroservices）的服务关联角色，ApiGateway-IntegrateWithMicroservices使用此角色来访问您在其他云产品中的资源。背景信息 API网关-微服务集成服务关联角色（ApiGateway-...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
IP访问控制插件
说明 WAF会将他收到的请求的源IP加入到X-Forwarded-For头的最后发送给API网关，API网关去判断X-Forwarded-For头中的这个值就可以。这种情况建议用户使用"XFF:1"来判断WAF前一跳的IP地址。resource字段填写格式为“XFF:index”，index的值为...
接入 SDK
要使用 SDK 访问 API 网关的 OpenAPI，您必须引入以下两个 SDK：基础 SDK：是 SOFAStack 中通过 SDK 调用任何 API 时都必须依赖的 SDK。基础 SDK-><dependency><groupId>cn.com.antcloud.api</groupId><artifactId>antcloud-api-sdk...
API 网关服务条款
请参见 API网关服务条款。
配置后端服务Host（域名头）
本文将介绍如何配置后端服务Host域名头，以及在API网关中后端服务Host域名头的优先级。Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景...
概述
在控制台上进行操作，具体可参考：通过导入Swagger创建API 2 API网关实例选择及分组 2.1 实例选择 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡，API网关支持共享实例和专享实例两种，适用于...
VPC下的用户使用API网关有什么要求？
需要保证 API 网关可以与相应底层服务通信，所以 VPC 下的用户需要使用 EIP 或 负载均衡，以便 API 网关调用您的底层服务。
- 产品推荐
- 这些文档可能帮助您