环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
CreateApiStageVariable-创建环境变量
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:CreateApiStageVariable Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID 523e8dc7bbe04613b5b1d726c2a7889d StageId string 是 环境 ID...
DescribeDeployedApi-查询API在指定环境中的定义
glmall-app-test FunctionComputeConfig object 后端为函数计算时的后端配置项 FcType string 函数计算服务类型 HttpTrigger RoleArn string Ram 授权给 API 网关访问函数计算的 arn acs:ram:111*:role/aliyunserviceroleforsas Method ...
DescribeApisWithStageNameIntegratedByApp-根据应用...
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DeleteApiStageVariable-删除环境的指定变量
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeleteApiStageVariable Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API 分组 ID 523e8dc7bbe04613b5b1d726c2a7889d StageId string 是 环境 ID...
SwitchApi-切换指定环境中正在运行中的API定义
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
专享实例
API网关的专享实例可以提供高性能和高SLA保证，更加适合生产环境使用。在您使用专享实例时，使用费用由实例规格使用费用和公网出访流量费用两部分构成。实例规格使用费用 目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示...
发布API商品
3.4 发布和调试API API配置完成后，需要发布到环境中才可进行调试、调用，在本例中直接发布到了"线上"环境中，更多关于API网关的环境管理的内容可以详见 环境管理。发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
创建后端为函数计算的API
您对API进行过任何的配置，都需要发布到对应的环境（API网关内置了三个环境：“线上“、“预发“、“测试“）中才能够生效。本例中，点击 发布，按照控制台页面的提示，把此API发布到“线上“环境。5 创建应用和API授权 应用（APP）是您...
对象存储
步骤9 发布API 您对API进行过任何的配置，都需要发布到对应的环境（API网关内置了三个环境：“线上“、“预发“、“测试“）中才能够生效。本例中，单击发布，按照控制台页面的提示，把此API发布到“线上“环境。5.创建应用和API授权 应用...
创建后端服务为VPC内资源的API
说明 对API进行过修改后，都需要发布到对应的环境（API网关内置了三个环境："线上"、"预发"、"测试"）中，新配置才能够生效。5.创建应用和API授权 应用（APP）是调用API服务时的身份。在本例中的步骤1中，认证方式选择的是"阿里云APP认证...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，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...
创建后端服务为HTTP的API
说明 对API进行过修改后，都需要发布到对应的环境（API网关内置了三个环境："线上"、"预发"、"测试"）中，新配置才能够生效。4 创建应用和API授权 应用（APP）是调用API服务时的身份。在本例中的步骤3中，认证方式选择的是“阿里云APP认证...
后端服务调不通
需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关提供了完整的后端签名验证的方式来做身份认证...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
概述
协议转换 API 网关不仅是一个简单的反向代理服务，同时还提供协议转换的能力，支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关，但是仅 Java 语言支持使用高级功能，比如服务端签名校验、数据加解密等，其他语言目前只能...
使用后端服务提高管理效率
发布API：在上一环节保存成功后，会提示您进行发布，您对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网关提供的错误码...
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...
D504CO错误码排查
1、Backend service connect failed `Timeout connecting to 172.X.X.1:80` 问题原因：API网关和后端服务建立连接超时导致的后端连接失败。解决方案：需要检查您录入的后端服务地址是否正确；如果后端服务在 ECS，请检查安全组设置，是否...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
API网关-微服务集成服务关联角色
本文为您介绍API网关-集成微服务（ApiGateway-IntegrateWithMicroservices）的服务关联角色，ApiGateway-IntegrateWithMicroservices使用此角色来访问您在其他云产品中的资源。背景信息 API网关-微服务集成服务关联角色（ApiGateway-...
VPC下的用户使用API网关有什么要求？
需要保证 API 网关可以与相应底层服务通信，所以 VPC 下的用户需要使用 EIP 或 负载均衡，以便 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网关服务条款。
参数映射与校验规则
目前API网关支持以下几种传输处理方式：入参 透传模式：API网关除 Path 位置的请求参数外，不对其他位置的请求参数进行映射与校验，用户参数会透明传递给后端，详细请阅读 章节3。入参映射（过滤未知参数）模式：API网关会根据用户配置的...
如何关闭公网访问
API网关支持关闭分组的公网访问，仅通过内网访问。操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 ...
- 产品推荐
- 这些文档可能帮助您