更新时间:2023-12-01 GMT+08:00
分享

基本概念

API

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。

API包括基本信息、前后端的请求路径、参数以及请求相关协议。

API分组

API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。

域名管理

在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。

环境

为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限使用的范围,称为环境。例如:API的测试环境,开发环境等。

环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。

调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。

环境变量

在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API在不同环境中调用不同的后端服务。

流量控制

流量控制支持从用户、凭据、源IP和时间段等不同的维度限制对API的调用次数,保护后端服务。

API网关代理支持按秒、分钟、小时、天粒度级别的流量控制。

访问控制

访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。

凭据

凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据,也支持将多个API授权给同一个凭据。

签名密钥

签名密钥由一对Key和Secret组成,用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。

当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息,此时,后端服务依照同样方式进行签名并得到签名结果,如果签名结果和API网关代理传过来的Authorization头中的签名一致,则可证明API请求确实来自API网关代理,而不是其他伪造请求。

VPC通道

API网关代理通过VPC通道访问部署在VPC内的服务,您可以借助API网关代理将部署在VPC中的后端服务开放给第三方用户调用。

简易认证

简易认证指调用API时,在HTTPS请求头部消息增加一个参数X-Apig-AppCode(参数值填AppCode),而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。

相关文档