API网关_API网关文档介绍内容-天翼云

API网关
API网关(API Gateway)是为企业开发者及合作伙伴提供的高性能、高可用、高安全的API托管服务,帮助企业轻松构建、管理和部署不同规模的API。借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。

来自：
帮助文档
API网关
API安全
本章主要介绍API安全常见问题。怎样保护API? 使用身份认证创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。设置访问控制策略从IP地址(或地址区间)以及帐号等不同维度,设置白名单/黑名单。将API绑定流控策略,通过流控策略保护API。 API网关默认API流量控制为每秒200次,如果您的后端服务不能支撑单个API 200次/秒的调用请求,可设置流量控制策略,将限额调低。怎样保证API网关调用后端服务器的安全?

来自：
帮助文档
API网关
常见问题
API安全
调用API
本章主要介绍调用API。 API提供者在API网关开放自己的API后,API调用者从API网关中调用API。调用限制如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。如果在API网关控制台“API管理 > API策略 > SSL证书管理”界面的“创建SSL证书”窗口中显示有“CA”参数,那么在调用API时,请注意以下限制。

来自：
帮助文档
API网关
调用API网关
调用已发布的API
调用API
新增网关响应
本章主要介绍新增网关响应。网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。

来自：
帮助文档
API网关
开放API网关
API分组管理
新增网关响应
API认证鉴权
本章主要介绍API认证鉴权常见问题。是否支持HTTPS的双向认证? 专享版:支持,在创建API时,可配置双向认证。 “无认证”方式的API该怎么鉴权与调用? “无认证”即API网关对收到的调用请求不做身份认证,您只需要按照API提供者提供的接口说明,封装规范的HTTP请求,发送给API网关即可。说明无认证方式下,API网关把请求内容透传给后端服务。因此,如果您希望在API后端服务进行鉴权,可以使用“无认证”方式,API调用方传递鉴权所需字段给后端服务,由后端服务进行鉴权。

来自：
帮助文档
API网关
常见问题
API认证鉴权
导出API
本章主要介绍导出API。操作场景导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。前提条件已创建API分组和API。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API列表”。步骤 4 单击导出API。步骤 5 设置如表所示参数。表导出API 信息项描述API分组选择待导出API所在的API分组。运行环境选择待导出API所在的环境。

来自：
帮助文档
API网关
开放API网关
API管理
导出API
API调用
是否支持移动应用调用API? API支持被移动应用调用。使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。如何实现WebSocket数据传输? API网关支持WebSocket数据传输,在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 API调用是否支持长连接 API网关支持长连接,但注意适当使用,避免占用太多资源。

来自：
帮助文档
API网关
常见问题
API调用
调用API流程
本章主要介绍调用API流程。作为API调用者调用API,您需要完成以下流程: 为简易认证添加AppCode 从API提供者中获取API和文档信息。创建应用并获取授权使用APP认证的API,需要在API网关中创建一个应用,并且绑定API后,才可以使用APP认证调用API。为简易认证添加AppCode 使用简易认证,API网关也仅校验AppCode。调用API 为简单起见,此处使用接口测试工具,通过APP认证方式中的凭证来实现对API的调用。

来自：
帮助文档
API网关
用户指南
调用API
调用API流程
API注册
本章主要介绍API注册问题。无法创建API是什么原因? API免费创建。如果被限制操作,可能原因为用户欠费。 API的响应码如何定义? 响应信息由后端API服务(即API的提供者)定义,API网关只做透传。使用VPC通道,后端服务的主机端口怎么填写? 填写API后端服务监听的端口。不使用VPC通道时,后端服务地址可以是什么? 可以是公网域名或者公网IP(支持公有云服务器的弹性IP地址)。后端服务地址是否一定要配置为ECS的地址?

来自：
帮助文档
API网关
常见问题
API注册
创建API
API网关支持WebSocket数据传输,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。l 子域名:所在分组的调试域名。l 路径:接口请求的路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置“+”号做前缀匹配,例如:/a/{b+}。注意,请求路径中的字母区分大小写。网关响应网关响应指未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default)。

来自：
帮助文档
API网关
开放API网关
API管理
创建API
创建API
网关响应网关响应指未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default)。如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。匹配模式分为两种模式:l 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。l 前缀匹配:调用的请求Path将以创建时填写的API请求Path为前缀,支持接口定义多个不同Path。

来自：
帮助文档
API网关
用户指南
API管理
创建API
导入API
本章主要介绍导入API。操作场景 Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。

来自：
帮助文档
API网关
开放API网关
API管理
导入API
发布API
另外,您还可以为API分组绑定一个或多个独立域名(详情请参考“API网关APIG用户指南>API分组管理> 绑定域名”章节),API调用者通过访问独立域名来调用您开放的API,这样即可不受每天最多访问1000次的规格限制。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
发布API
创建API分组
API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。实例创建后,有一个DEFAULT分组,可直接通过虚拟私有云地址调用默认分组中的API。前提条件已创建API网关实例。直接创建步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API分组”。步骤 4 单击“创建API分组 > 直接创建”,在弹框中填写分组信息。

来自：
帮助文档
API网关
用户指南
API管理
创建API分组
发布API
本章主要介绍发布API。创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。说明已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。同一个API在每个环境中最多记录10条最新的发布历史。发布API 步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。

来自：
帮助文档
API网关
用户指南
API管理
发布API
其他
相关错误码请参考API网关有哪些错误码。 API网关是否支持部署到本地? 目前不支持API网关部署到本地。

来自：
帮助文档
API网关
常见问题
其他
创建使用自定义认证且后端为FunctionGraph的API
创建后端业务函数 API网关(APIG)支持选择FunctionGraph作为后端服务类型,当请求设置函数工作流为后端服务的API时,API网关会触发相应的函数,函数工作流会将执行结果返回给API网关(APIG)。创建函数方法与上述创建自定义认证函数相同,只需修改函数名称,避免名称重复。在函数详情页的“代码”页签,进行代码在线编辑,并传入如下所示的代码,完成后单击“部署”,更新函数。

来自：
帮助文档
函数工作流
最佳实践
创建使用自定义认证且后端为FunctionGraph的API
概述
本章主要介绍API网关的概述。 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。若您想快速体验开放API和调用API的操作流程,请参考开放API和调用API。这里以APP认证类型的简易认证举例,端到端操作快速上手。使用流程使用API网关进行API的托管流程如下图所示。

来自：
帮助文档
API网关
用户指南
概述
公测实例转正式商用
本文主要介绍公测实例转正式商用 API网关于2023年1月10日00:00:00正式商用。请在公测期间订购该产品的客户根据自身业务需求考虑是否需要继续使用该产品,若继续使用该产品,则从转商之日起将正式收取公测期间创建的API网关实例的按需费用,若不考虑继续使用,请于转商日之前删除对应API网关实例,以免产生计费;删除公测期间API网关实例步骤如下: 1、登录API网关管理控制页; 2、在左侧导航表选择API网关->专享版; 3、选中公测期间的API网关实例,点击右上角更多->删除。

来自：
帮助文档
API网关
计费说明
公测实例转正式商用
最佳实践概述
本章主要介绍最佳实践概述场景描述本手册基于天翼云API网关实践所编写,用于指导您开放并调用API。应用场景范围:基于天翼云API网关开放容器应用服务。云容器引擎(CT-CCE,Cloud Container Engine,简称CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。方案优势借助API网关开放CCE容器应用,具有如下优势: 无需设置弹性公网IP,节省网络带宽成本 API网关支持建立VPC通道,访问CCE中工作负载的地址。

来自：
帮助文档
API网关
最佳实践
APIG开放CCE云容器应用
最佳实践概述
基本概念
网关响应网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。

来自：
帮助文档
API网关
产品简介
基本概念
注册API
本章节主要介绍注册API。本文将为您介绍如何注册API,与通过数据表生成的API统一管理和发布到API网关。目前数据服务共享版支持Restful风格的API注册,包含GET/POST常见请求方式。配置API基本信息 1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。详见下图:选择数据服务 2.在左侧导航栏选择服务共享版,进入总览页。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
创建API
注册API
删除API
本章主要介绍删除API。操作场景已发布的API不再提供服务,可以将API删除。说明该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。已发布的API,需要先下线API,再删除。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API列表”。步骤 4 单击API 分组名称 ,进入API分组详情页面。

来自：
帮助文档
API网关
开放API网关
API管理
删除API
通过API访问CCE最佳实践
请求协议:选择API请求协议,此处选择“HTTPS”。子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。路径:接口请求路径。网关响应API网关未能成功处理API请求,从而产生的错误响应。默认网关响应为“default”。匹配模式此处选择“前缀匹配”。安全认证选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 配置后端信息后,单击“下一步”。

来自：
帮助文档
API网关
最佳实践
APIG开放CCE云容器应用
通过API访问CCE最佳实践
产品定义
如果您作为API调用者,您可以获取并调用API提供者在API网关开放的API,减少开发时间与成本。例如,企业A在API网关中开放了电话号码归属地查询API,并发布到API市场。企业B通过API市场调用此API,并支付调用此API所产生的费用。此时,企业A通过开放业务能力,使自身服务能力变现,企业B直接调用企业A开放的API,减少开发时间与成本,最终实现企业间的共赢。图 API网关服务简介

来自：
帮助文档
API网关
产品简介
产品定义
功能特性
签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。

来自：
帮助文档
API网关
产品简介
功能特性
产品优势
本节主要介绍API网关的产品优势。简单易用只需在管理控制台中配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。便捷管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。精细监控 API网关采用同步加异步混合流控的方式,通过多种算法,实现精细化的秒级流控。同时提供灵活自定义的流量控制策略制定,保障API服务的稳定和连续。

来自：
帮助文档
API网关
产品简介
产品优势
API导入导出
本章主要介绍API导入导出常见问题。 API导入失败是什么原因? 可能原因1:单次导入的API数量超出上限。当前单次最高能导入300个API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 swagger导入API的扩展字段有没有模板? 模板在开发中。您可以先配置好1~2个API,再导出作为模板。

来自：
帮助文档
API网关
常见问题
API导入导出
SDK介绍
本章主要介绍API网关的SDK。操作场景 API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。API使用APP认证时,请根据需要下载SDK包和文档,参考文档完成API的调用。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 单击“帮助中心”,进入到帮助中心页面。帮助中心页面有一个“SDK使用指引”页签。步骤 4 在待下载的语言中,单击“下载SDK”,下载SDK包。

来自：
帮助文档
API网关
调用API网关
SDK介绍
查看凭据绑定的API详情
本章主要介绍查看凭据绑定的API详情。操作场景在凭据绑定API后,查看凭据绑定的API详情。前提条件已创建凭据。凭据已绑定API。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > 凭据管理”。步骤 4 单击凭据名称 ,进入凭据详情页面。步骤 5 在关联API中单击待查看的API,进入API详情页面,查看API详情。

来自：
帮助文档
API网关
调用API网关
应用管理
查看凭据绑定的API详情
创建并使用签名密钥
操作场景签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。说明每个用户最多创建30个签名密钥。

来自：
帮助文档
API网关
开放API网关
签名密钥
创建并使用签名密钥
开放API流程
本章主要介绍开发API流程。作为API提供者开放API,您需要先后完成以下流程: 创建实例。使用API网关专享版,需要购买专享版实例。创建API分组 API分组相当于API的集合,您在创建API前,需要先创建API分组。绑定域名开放API前,您需要为API分组绑定独立域名(即自定义域名),API调用者通过访问独立域名来调用您开放的API。创建API 创建API包括定义API前后端的请求路径、参数、请求相关协议等。调试API 提供调试功能,调试API接口,验证服务是否正常。

来自：
帮助文档
API网关
用户指南
API管理
开放API流程

天翼云最新活动

618智算钜惠季

爆款云主机2核4G限时秒杀，88元/年起！

免费体验DeepSeek，上天翼云息壤

新老用户均可免费体验2500万Tokens，限时两周

云上钜惠

爆款云主机全场特惠，更有万元锦鲤券等你来领！

算力套餐

让算力触手可及

天翼云脑AOne

连接、保护、办公，All-in-One！

中小企业应用上云专场

产品组合下单即享折上9折起，助力企业快速上云

息壤高校钜惠活动

天翼云息壤杯高校AI大赛，数款产品享受线上订购超值特惠

天翼云电脑专场

移动办公新选择，爆款4核8G畅享1年3.5折起，快来抢购！

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

弹性云主机

物理机

GPU云主机

轻量型云主机

一体化计算加速平台·异构计算

天翼云CTyunOS系统

科研助手

人脸实名认证

人脸属性识别

推荐文档

文档下载

切换可用性策略

修改数据库端口

iOS客户端需求