使用 RAM 管理 API
API 网关结合阿里云访问控制（RAM）来实现企业内多职员分权管理 API。API 提供者可以为员工建立子账户，并控制不同职员负责不同的 API 管理。使用 RAM 可以允许子账号，查看、创建、管理、删除 API 分组、API、插件等。但子账号不是资源的...
概述
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
支持 HTTPS
步骤2：绑定SSL证书 准备好以上材料，需要进行如下操作进行，登录API网关管理控制台【开放API】-【分组管理】，单击您需要绑定SSL证书的分组，查看分组详情。在绑定SSL证书，您首先需要您在API分组上绑定【独立域名】。【独立域名】-添加...
API概览
网关管理 API 描述 CreateGateway 调用CreateGateway创建一个新网关。ModifyGateway 调用ModifyGateway修改网关的基本信息。DeleteGateway 调用DeleteGateway删除网关信息。StopGateway 调用StopGateway停止网关服务。...
基于Swagger完成API网关与用户CICD流程整合
一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关提供的管理接口进行封装整合。如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1...
TCP连接超时时间配置
使用API网关的TCP连接超时时间配置原则 下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...
插件数据集
插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活性。但在一些大型业务场景，API网关的文本插件对用户的业务起到了限制作用，因此我们将插件中的配置数据抽象成数据集对象进行单独管理，...
API 网关服务等级协议（SLA）
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
通过日志服务查看API调用日志
API网关 和 日志服务 实现无缝集成，通过日志服务您可以进行实时日志查询、下载、多维度统计分析等，您也可以将日志投递到 OSS 或者 MaxCompute。日志服务每个月前500MB免费，具体价格请参照：日志服务定价。1 功能简介 1.1 日志在线查询 ...
阿里云API网关试用服务协议
前言 欢迎使用阿里云API网关（Alibaba Cloud API Gateway）服务。在开通阿里云API网关服务前，请您仔细阅读 阿里云网站 上公布的相关规范、规则和使用流程以及本服务协议的全部内容，如果您不同意前述任意内容，或者无法准确理解阿里云的...
概述
协议转换 API 网关不仅是一个简单的反向代理服务，同时还提供协议转换的能力，支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关，但是仅 Java 语言支持使用高级功能，比如服务端签名校验、数据加解密等，其他语言目前只能...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
如何获取错误信息
BBAF-EFB340E0A5AF/API网关返回的错误消息，当请求出现错误时API网关会通过响应头将错误消息返回给客户端 X-Ca-Error-Message:Invalid Parameter Required `field1`/API网关系统错误码，当请求出现错误被网关拦截后，由API网关提供的错误码...
简介
欢迎使用阿里云API网关服务。用户可以使用本文档介绍的API对API网关服务进行相关操作。请确保在使用这些接口前，已充分了解了API网关产品说明、使用协议和收费方式。术语表 术语 全称 中文 说明 Region 地域 用户开放API，需选择API在API...
混合云API集中管理
同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行调用。概述 API网关默认只能和同Region的VPC相互连通。本文中的API网关为...
D504CO错误码排查
1、Backend service connect failed `Timeout connecting to 172.X.X.1:80` 问题原因：API网关和后端服务建立连接超时导致的后端连接失败。解决方案：需要检查您录入的后端服务地址是否正确；如果后端服务在 ECS，请检查安全组设置，是否...
VPC下的用户使用API网关有什么要求？
需要保证 API 网关可以与相应底层服务通信，所以 VPC 下的用户需要使用 EIP 或 负载均衡，以便 API 网关调用您的底层服务。
配置后端服务Host（域名头）
本文将介绍如何配置后端服务Host域名头，以及在API网关中后端服务Host域名头的优先级。Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景...
接入 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.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个...
如何有效防止API的重放攻击？
这种认证的签名方式请参照：请求签名 在API网关的签名中，提供X-Ca-Timestamp、X-Ca-Nonce两个可选HEADER，客户端调用API时一起使用这两个参数，可以达到防止重放攻击的目的。原理 请求所有的内容都被加入签名计算，所以请求的任何修改，...
产品架构
API 网关主要由 GW Controller 和 Mosng 两个组件构成，GW Controller 将数据推送给 Mosng 后，Mosng 开始对外提供服务。本文主要结合这两个组件介绍 API 网关架构。API Gateway 系统主要由以下组件构成：GW Controller：网关控制台，负责...
支持在线协议吗？如果是线下协议如何操作？
支持在线协议，在开通 API 网关服务时，需要签订使用协议。线下协议需告知 API 网关产品经理和相关法务。
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
如何配置出访连接池告警
若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大支持的出访RPS是1200，超过1200后，如果请求进入API网关，后端连接池被占满，API网关会让请求进入一个等待队列，...
导入数据模型
为了方便用户快速生成数据模型，API 网关支持通过 Proto 文件和 Swagger 文件来快速导入数据模型。操作步骤 登录 API 网关控制台。在左侧导航栏单击 API 发布>数据模型，进入数据模型页面。在页面右上角单击 导入数据模型，在弹出的窗口中...
如何给指定人开放API？
API 网关，提供访问权限控制功能，您可以在控制台，为每个 API 配置访问权限。
产品应用场景及作用
通过 API 网关可以将您部署在云服务器 ECS、容器服务上部署的应用，以 API 形式全部或有限开放。
支持HTTP2.0
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...
如何查看API的运行情况
API 网关，为您提供监控服务，您可以在控制台，以图表形式查看您 API 的调用量、流量大小及错误分布等监控信息。
二级域名是什么，有什么使用限制？
因为API网关对外的IP可能会变化（IP可能会因为各种原因被禁用或者更换），所以您需要将自己的独立域名CNAME到一个固定的二级域名上。通过公网访问API网关。注意：二级域名您也可以直接调用，不过仅供测试使用，每个二级域名每天1000次访问...
配置记录HTTP请求应答日志
如果需要在日志中记录API网关收到的HTTP的请求及API网关返回给客户端的HTTP应答，您可以在分组详情中进行设置。记录请求Headers：逗号分隔需要记录的Header名称（如上图所示），'*' 记录全部 记录应答Headers：逗号分隔需要记录的Header...
概述
API 网关是一个 API 服务管理平台。企业可以在 API 网关产品上将自己的业务服务创建发布为一个 API，并对外授权给外部的合作伙伴。合作伙伴系统即可向 API 网关产品上的 API 发动调用请求。API 接到请求后就会通过 API 网关将请求转发给后...
FunctionComputeConfig
子节点"class="reference-link">子节点 名称 类型 描述 fcRegionId String 函数计算所在Region serviceName String 函数计算定义的ServiceName functionName String 函数计算定义的FunctionName roleArn String Ram授权给API网关访问函数...
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。该功能常用于多部门协同、实现参数统一规范，以及实现统一错误码等场景。操作步骤 进入 API 网关控制台页面，在左侧...
PAI
阿里云机器学习平台PAI（Platform of Artificial Intelligence），为传统机器学习和深度学习提供了从数据处理、模型训练、服务部署到...PAI EAS可以将模型以REST API的形式发布到API网关，业务系统可以使用HTTP的方式加以调用，公网地址调用。
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
Mock
API 网关也支持 Mock 模式的简单配置。配置 Mock 在 API 编辑页面-定义API后端服务，来配置 Mock。1.填写 Mock 返回结果 Mock 返回结果，可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如：{"result":{...
- 产品推荐
- 这些文档可能帮助您