全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
API 网关

简介

更新时间:2017-06-07 13:26:11

欢迎使用阿里云 API 网关服务。用户可以使用本文档介绍的 API 对 API 网关服务进行相关操作。

请确保在使用这些接口前,已充分了解了 API 网关产品说明、使用协议和收费方式。

术语表

术语 全称 中文 说明
Region 地域 用户开放API,需选择API在API网关的部署地域,建议选择与后端服务相同的Region。
API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。
Group API Group API分组 一组API。
  • 用户开放API,首先需要创建API分组
  • 每个API分组拥有一个二级域名,两个Stage
  • 用户需要将已经备案且解析至分组二级域名的独立域名绑定到API分组上
  • 同分组下的API均可通过已绑定的独立域名访问
SubDomain 分组二级域名 用户开放API,创建的每个API分组都有一个二级域名,独立域名需要解析到该二级域名上,直接访问该域名可以调用测试环境的API。
CustomDomain Custom Domain 域名 用户开放API,需要绑定自己的独立域名,该域名需要CNAME解析到分组二级域名上且在阿里云备案或备案接入。且若支持HTTPS协议,还需为域名上传SSL合规证书。
Stage 环境 用户开放API,创建的每个API分组目前有两个环境,测试和线上。用户操作API发布到某个环境后,API才能被调用。区别在于,直接访问分组二级域名调用API,默认是调用测试环境。
Signature Backend Signature 后端签名密钥 用于开放API的用户给API网关颁发身份验证密钥。后端签名密钥绑定到API后对绑定的API即时生效。网关接收到这些API的请求,再去请求后端服务的时候就会带上签名信息,供后端服务对API网关做身份校验。
TrafficControl 流量控制策略(简称“流控策略”) 用于开放API的用户对API做访问流控。流控策略与API绑定后对绑定的API即时生效。流控策略可以从Api、App、User三个维度管控API的调用。流控策略下还可以配置特殊流控,如某App/User在调用绑定的API时,可以按照特殊的值来流控。
Special Special Traffic Control 特殊流量控制(简称“特殊流控”) 是流控策略的一个配置,可以指定某App/User,针对流控策略绑定的API,按照单独的值进行流控。
APP 应用 调用其他用户开放的API时,需要创建一个APP作为调用者的身份。请求到达网关时,会对AppKey和AppSecret进行签名校验。

业务限制资源规格限制说明

在 API 网关中,对每个用户可创建的API分组、API个数都有限制,对用户经过API网关调用开放的API也有限制。详情请参考官网文档对使用限制的说明《开放API使用限制》和《调用API使用限制》。

在接口说明部分,凡出现与官网上给出的限制发生矛盾时,均以官网的限制说明为准。

本文导读目录