发送 HTTP 请求（Java）
说明 网关提供客户端 Demo 代码供用户参考，下载 API 订阅者 Demo 后，Demo 代码位置为：src/test/java/com/alipay/gateway/web/test/usercase/mainchain/http/ 前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关...
客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
使用SDK调用API
概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考 创建后端服务为HTTP的API，支持SDK调用的API需满足：API的安全认证方式为“阿里云APP...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
如何配置出访连接池告警
前提条件 已经配置记录API网关的日志，文档可参考 通过日志服务查看API调用日志。配置出访连接池告警 日志服务支持根据定义的检查频率、触发条件等配置告警规则，并在满足条件时触发告警。所以我们可以使用日志服务来进行告警。当出访连接...
API参考
EMAS提供数据开放接口，您可以通过API访问您应用的数据。本章将产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来供您参考。移动研发平台 OpenAPI
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
参数与条件表达式的使用
本文讲述API网关的参数以及条件表达式的使用。1.概述 在插件中，支持用户从当前的 请求、应答 或 系统上下文 中获取参数，并使用自定义的 条件表达式 对参数进行判断，本文描述 参数 的定义方法与 条件表达式 的书写方法。2.参数的定义 2.1...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的...Api网关支持的模型可以参考如下定义：{"required":["name","photoUrls"],"type":"object","properties":{"id":{"format":"int64","type":"integer"},"category":{"$ref":...
SDK下载及使用指南
若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务（包括在 API 市场购买的 API 服务）注意这里的 API 服务是指在 API 市场购买的，或者您在 API 网关接入开放的，或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
VPC授权连通性测试
这三条数据可以唯一确定您的一个业务服务，并授权API网关访问该业务服务，具体可参考 使用VPC内资源作为API的后端服务。2.连通性测试 进入API网关控制台-API管理-VPC授权，根据上述文档创建VPC授权。在操作列表可以看到 连通性测试。点击 ...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本迭代过程中，新版本服务正式发布前通过API网关进行灰度发布，A/B Test的通用方法实践。该方法的核心是通过配置后端路由插件来确保可以控制服务升级对用户造成的影响。一、概述 灰度发布是指在API的新、旧...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
开通IPv6
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例分配...
后端服务调不通
API网关实例出口IP查看方法：API网关的出口IP请查看分组所在实例的出口IP，具体查看方法：1、先登录 API网关控制台-【API管理】-【分组管理】-【分组详情】查看分组所在实例信息。2、到【实例与集群】页面查看对应实例的出口地址。
D504CO错误码排查
排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考 访问云服务。2、Backend service connect failed `...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
API分组的归属实例迁移
2 迁移步骤 您可以在控制台的左侧栏的 API管理 —— 分组管理 —— 分组详情页 中找到变更分组实例链接，单击变更分组实例，选择 目标实例，务必仔细阅读注意事项，之后单击 确认迁移 完成分组迁移，分组迁移会实时生效在API网关二级域名的...
CreateModel-创建模型
接口说明 模型定义参考 JSON 架构草案 4 的规范 Json Schema 只支持 Object 类型的元素属性。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息...
HTTP自动跳转HTTPS
前提条件 分组已绑定域名并已...操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的自动跳转开启成功。
BasicAuth插件
关于BasicAuth跨域资源访问的基础知识可参考 这篇文章。插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索yaml to json转换工具来进行配置格式的转换，YAML格式的模板见下表。users:username:alice ...
跨域资源访问（CORS）
关于CORS跨域资源访问的基础知识可参考 跨域资源共享（CORS）。插件配置 可以选择JSON者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索yaml to json转换工具来进行配置格式的转换，yaml格式的模板见下表。allowOrigins:api.foo...
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
- 产品推荐
- 这些文档可能帮助您