阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
基于Swagger完成API网关与用户CICD流程整合
API网关致力于让用户专注于后端服务的开发,将认证、流控等通用切面功能交给API网关处理，结合ImportSwagger接口的使用，完成后端服务与API网关的联动，大大减少了API网关的配置过程。同时，让API网关的配置和管理集成到用户的CICD流程中...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
SLB服务调用API网关超时的问题分析与处理步骤
问题描述 SLB服务 调用API网关进行虚拟服务器组负载调整时进程异常，报如下错误。cause by(ClientException):SDK.ServerUnreachable:SocketTimeoutException has occurred on a socket read or accept.at ...
微信小程序调用API网关提示SSL握手失败
问题描述 使用微信小程序请求API网关时，可能提示“fail ssl hand shake error”。具体表现为使用PC端开发者工具请求不报错、使用苹果真机调试不报错、只有使用安卓真机调试报错。问题原因 证书链部署不完全导致，用户只部署了域名证书而...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
多级API网关
API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关在调用自身时会使用AK生成签名发送给目标API网关进行鉴权认证。一个典型的场景是，用户有个负责分发的API，这个API绑定一个后端路由...
API网关灰度发布最佳实践
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
API 网关服务条款
请参见 API网关服务条款。
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
函数计算内网访问API网关
本文介绍在函数计算中如何通过VPC访问API网关，包括两种情况：在同一Region，以及在跨Region情况下如何访问。1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，...
API 网关服务等级协议（SLA）
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
API网关-事件总线服务关联角色
应用场景 用户在创建事件总线类型的后端服务时，API网关会提示用户创建事件总线服务关联角色，在后续操作中，用户在API网关创建后端为事件总线的API并调用，API网关在上传事件到用户的事件总线时需要使用服务关联角色...
API网关-监控服务关联角色
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
API网关-微服务集成服务关联角色
本文为您介绍API网关-集成微服务（ApiGateway-IntegrateWithMicroservices）的服务关联角色，ApiGateway-IntegrateWithMicroservices使用此角色来访问您在其他云产品中的资源。背景信息 API网关-微服务集成服务关联角色（ApiGateway-...
导入API网关的扩展Swagger定义
现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0，可以创建API实体的Swagger定义，并将Swagger导入API网关用于批量创建或者更新API...
CreatePlugin-创建API网关插件
新建API网关插件。接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量，不同类型，上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。调试 您可以...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
使用限制
本文描述了API网关的使用限制。限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多...
参数映射与校验规则
目前API网关支持以下几种传输处理方式：入参 透传模式：API网关除 Path 位置的请求参数外，不对其他位置的请求参数进行映射与校验，用户参数会透明传递给后端，详细请阅读 章节3。入参映射（过滤未知参数）模式：API网关会根据用户配置的...
使用OpenAPI
本文为您介绍使用API网关OpenAPI的基本信息及注意事项。说明 关于如何使用阿里云OpenAPI，请参见学习文档：使用OpenAPI。基本信息 版本说明 版本号 说明 2016-07-14 推荐 接入点说明 参见 服务接入点。用户身份 用户身份 支持情况 阿里云...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
新功能发布记录
可以用authResultPassThrough来配置发送给后端服务的参数映射 全部 第三方鉴权插件 流控插件支持固定窗口算法 API网关流控插件秒级别默认使用的是令牌桶流控算法，可以通过配置切换成固定时间窗口流控算法 全部 流量控制插件 2023-02 功能...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
搭建无服务器应用之手机号归属地查询
本文主要介绍配合使用API网关、函数计算和云市场三种产品，搭建一个可以查询手机号归属地的服务。在这个框架里不需要配置Web容器、不需要搭建运行环境、不需要购买负载均衡，通过配置和一段代码即可完成一个高扩容无服务器的应用服务。服务...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
客户端调用API示例
响应头：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF#请求唯一 ID，请求一旦进入 API 网关应用后，API 网关就会生成请求 ID 并通过响应头返回给客户端，建议客户端与后端服务都记录此请求 ID，可用于问题排查与跟踪。...
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求...
调用API商品
优点：简单易用，无需复杂的生成签名的过程，各种开发语言都能很简单的使用，API商品也提供了多语言的调用示例。缺点：认证方式本身的安全性较低，AppCode在网络的传输过程是以明文的方式在Http Request中，因此存在泄露风险。使用建议：...
导入标准OAS定义
API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括如下过程：选择目标分组和全局信息。录入OAS 2.0格式的API定义，或OAS 3.0格式的API定义 进行预检并根据检查结果进行调整...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
基于JWT的token认证
1.2 流程描述 上图是API网关利用JWT鉴权插件实现认证的整个业务流程时序图，下面我们用文字来详细描述图中标注的步骤：客户端向API网关发送请求，请求中携带token；API网关使用用户插件中配置的公钥对请求中的token进行验证，验证通过后，...
- 产品推荐
- 这些文档可能帮助您