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

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

来自：
帮助文档
API网关
用户指南
API管理
开放API流程
创建API分组
本章主要介绍创建API分组。操作场景创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。说明一个API只能属于某一个API分组。每个用户最多创建50个API分组。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API分组”。步骤 4 单击“创建API分组 > 直接创建”,在弹框中填写分组信息。

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

来自：
帮助文档
API网关
开放API网关
签名密钥
创建并使用签名密钥
开启跨域访问
API网关响应消息中的跨域头。

来自：
帮助文档
API网关
开放API网关
API管理
开启跨域访问
实施步骤
目的地址为API网关专享版实例概览页面,“基本信息”页签中的“出私网IP”地址。 b. 单击“确定”。配置路由返回API网关控制台。在左侧导航栏选择“实例管理”。单击已创建API网关专享版实例的名称或“查看控制台”。在“路由”区域,单击“更改”配置路由,配置IP为创建ELB所在VPC2的网段。单击“保存”。创建API 在API网关控制台的左侧导航栏选择“API管理 > API列表”,单击“创建API > 创建API”。配置前端信息后,单击“下一步”。

来自：
帮助文档
API网关
最佳实践
API网关跨VPC开放后端服务
实施步骤
响应消息头
调用API时,API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。

来自：
帮助文档
API网关
调用API网关
调用已发布的API
响应消息头
到期与欠费
本节主要介绍到期与欠费在API网关实例资源将要到期或欠费时,天翼云会以邮件的方式通知客户,如用户需继续使用,则可联系客户经理执行续费操作或自行在控制台进行续订。如果用户未执行续费操作,天翼云将发送资源超期提醒邮件,并在之后释放API网关实例资源。从包周期API网关到期或按需用户发生欠费时算起,资源将进入15天冻结期,超过冻结期后,资源将被删除回收,资源删除后用户数据不可恢复。欠费后,可以查看欠费详情。

来自：
帮助文档
API网关
计费说明
到期与欠费
API控制策略
本章主要介绍API控制策略常见问题。 API流量控制是否支持对请求并发次数做自定义控制? 不支持。流控策略只控制单位时间内调用次数,无请求并发次数控制。每个子域名每天最多可以访问1000次,如果帐号为企业帐号,是否还有这个限制? 每个子域名每天最多可以访问1000次的限制同样适用于企业帐号。 API调用是否存在带宽限制专享版API网关存在带宽限制,在创建实例时可以选择公网入口以及出口带宽。流量控制策略不生效怎么办?

来自：
帮助文档
API网关
常见问题
API控制策略
应用场景
而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速完成企业内部系统的解耦及前后端分离。同时,复用已有能力,避免重复开发造成的资源浪费。企业能力开放当今企业面临巨大的挑战,企业的发展需要依赖外部合作伙伴的能力,典型的例子如使用第三方平台支付、合作方帐户登录等。通过API网关将企业内部服务能力以标准API的形式开放给合作伙伴,与合作伙伴共享服务和数据,达成深度合作,构建企业共赢生态。

来自：
帮助文档
API网关
产品简介
应用场景
使用APIG（专享版）触发器
API触发器创建完成后,会在API网关生成名为API_apig的API,单击API名称,跳转至API网关服务。调用函数 1、在浏览器地址栏输入APIG触发器的调用地址URL,按“Enter”。 2、函数执行完毕,得到返回结果,如下图所示。返回结果说明1. FunctionGraph函数对APIG调用的传入值为函数自带的事件模板。2.

来自：
帮助文档
函数工作流
用户指南
配置触发器
使用APIG（专享版）触发器
修改专享版实例
本节主要介绍修改专享版实例 API网关专享版实例的部分基本信息以及配置参数,可以从控制台修改。修改实例信息专享版实例创建后,您可能需要调整实例的一些配置,比如调大出公网的带宽,以便支撑更高的API请求流量。步骤 1 进入API网关控制台页面。步骤 2 在左侧导航栏选择“实例管理”。步骤 3 在待查看或编辑的实例上,单击“查看控制台”或实例名称。步骤 4 在“实例信息”页签,找到您需要调整实例的基本信息项并进行修改。

来自：
帮助文档
API网关
快速入门
修改专享版实例
约束与限制
本节主要介绍API网关的约束与限制。如果您需要修改默认限制值,请联系技术支持申请扩大配额。表 API网关配额管理明细限制项默认限制能否修改 API分组数量每个用户最多创建50个API分组。 √ API数量每个用户最多创建200个API。 √ 后端策略数量每个用户最多创建5个后端策略。 √ 应用数量每个用户最多创建50个应用。应用配额包括用户自行创建的应用和API市场购买API生成的应用。 √ 流控策略数量 * 每个用户最多创建30个流控策略。

来自：
帮助文档
API网关
产品简介
约束与限制
操作流程
创建VPC 创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。 2. 购买API网关专享版实例在VPC1上购买API专享版实例。 3. 购买ELB 在VPC2上购买弹性负载均衡。 4. 创建对等连接创建VPC Peering对等连接,打通VPC1和VPC2。 5. 配置路由在API专享版实例上配置路由,配置IP为已购买ELB所在VPC2网段。 6. 创建API 创建API,后端服务地址配置ELB的IP。 7.

来自：
帮助文档
API网关
最佳实践
API网关跨VPC开放后端服务
操作流程
创建函数流触发器
创建APIG(共享版)触发器说明首次使用API网关的用户不再支持共享版服务,老用户仍可继续使用共享版服务。即API网关当前已不提供共享版,目前只有存量用户可以使用共享版。函数流APIG触发器目前仅支持IAM认证方式。登录FunctionGraph控制台,进入“函数流”页面。在“函数流”流程列表页面,选择需要创建触发器的流程,单击“编辑”,进入编辑页面。单击“开始”节点,在右侧弹出的属性页面添加触发器,触发器类型选择“APIG触发器(共享版)”。填写触发器配置信息。

来自：
帮助文档
函数工作流
用户指南
函数流管理
创建函数流触发器
创建负载通道
图通过API网关访问负载通道中的ECS 前提条件用户需要具备VPC Administrator角色权限。创建负载通道步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 单击“负载通道”页签,进入到负载通道列表页面。步骤 5 单击“创建负载通道”,配置基本信息。表基本信息配置信息项描述通道名称自定义负载通道名称,用于识别不同的负载通道。

来自：
帮助文档
API网关
开放API网关
负载通道
创建负载通道
与其他服务依赖关系
表对接服务服务名称实现功能相关内容 API网关(API Gateway) 通过HTTPS调用FunctionGraph函数,使用API Gateway自定义REST API和终端节点来实现。详细内容参见API网关对象存储服务(OBS) 构建FunctionGraph函数来处理OBS存储桶事件,例如对象事件或删除事件。当用户将一张照片上传到存储桶时,OBS存储桶调用FunctionGraph函数,实现读取图像和创建照片缩略图。

来自：
帮助文档
函数工作流
产品简介
与其他服务依赖关系
脚本模式生成API
详见下表: API基本信息配置说明 API名称支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。 API目录一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。您可单击“新建”进行新建,也可选择已创建的API分组。请求Path API访问路径,例如:/v2/{project_id}/streams。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
创建API
脚本模式生成API
删除特殊凭据或租户
删除特殊凭证步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“策略管理”页面,单击待删除特殊凭据的流量控制策略的名称,进入流量控制详情页面。步骤 5 单击“特殊凭据”,进入“特殊凭据”页面。步骤 6 在待删除的特殊凭据所在行,单击“删除”,弹出“删除特殊凭据”对话框。步骤 7 单击“确定”,完成对特殊凭据的删除。删除特殊租户步骤 1 进入API网关控制台页面。

来自：
帮助文档
API网关
开放API网关
流量控制
删除特殊凭据或租户
产品价格
本节主要介绍产品价格专享版API网关计费说明专享版API网关分两个维度计费:版本,以及带宽,二者同时计入收费。实例版本分为基础版、专业版、企业版、铂金版。不同版本收费价格不一,目前支持包周期(包年包月)和按需(小时)两种计费方式。包年优惠政策为1 年 85 折、2 年 7 折、3 年 5 折。

来自：
帮助文档
API网关
计费说明
产品价格
查询分析
本章节为您介绍API安全网关的查询分析模块功能。查询分析包含两个模块:审计日志和告警日志。审计日志保存访问API安全网关系统的流量记录,告警日志保存API网关规则预警的告警信息。审计日志1.登录API安全网关。2.在左侧导航栏选择“查询分析 > 审计日志”,进入审计日志页面,即可查看审计日志。单击右上角的“展开”可以设置查询条件(开始时间、响应码、客户端IP、上游、请求URL)。大模型审计日志1.登录API安全网关。

来自：
帮助文档
数据安全专区
用户指南
API安全网关操作指导
查询分析
审计
本节主要介绍审计开通云审计服务如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景时,需要先开通云审计服务。云审计服务包含以下功能: 记录审计日志审计日志查询审计日志转储事件文件加密关键操作通知查看审计日志如果需要查看审计日志,可查看日志追踪事件。图查看日志查看关键操作列表通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。

来自：
帮助文档
API网关
审计
审计
为简易认证添加AppCode
操作场景简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。说明为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。每个应用最多可创建5个AppCode。

来自：
帮助文档
API网关
调用API网关
应用管理
为简易认证添加AppCode
添加特殊凭据或租户
添加特殊凭据步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“策略管理”页面,单击已创建的策略,进入流控详情。步骤 5 单击“添加特殊凭据”,弹出“添加特殊凭据”对话框。步骤 6 通过以下两种方式,添加特殊凭据。添加已有凭据:单击“已有凭据”,选择已有凭据,输入阈值。添加其他凭据:单击“其他”,输入其他用户的凭据ID和阈值。

来自：
帮助文档
API网关
开放API网关
流量控制
添加特殊凭据或租户
购买专享版实例
步骤 3 单击管理控制台左上角,然后单击“API网关 APIG”。步骤 4 在左侧导航栏单击“专享版”。步骤 5 单击“购买专享版实例”,进入实例购买的配置页面。表 API网关专享版实例参数说明参数项说明区域指APIG专享版实例部署的区域,建议和您其他的业务部署在相同区域,这样不同的业务可以在VPC内以子网方式通信,节省公网带宽成本,降低网络延时。可用区指同一区域内电力、网络等资源物理隔离的地理区域,一般为互相独立的机房。

来自：
帮助文档
API网关
快速入门
购买专享版实例
数据治理中心DataArts Studio与其他服务的关系
API网关服务 DataArts Studio通过API网关服务(API Gateway,简称APIG)对外开放各组件的API接口。数据湖探索服务 DataArts Studio支持将数据湖探索服务(Data Lake Insight,简称DLI)作为数据湖底座,进行数据集成、开发、治理与开放。 MapReduce服务 DataArts Studio支持将MapReduce服务(简称MRS)作为数据湖底座,进行数据集成、开发与治理。

来自：
帮助文档
数据治理中心 DataArts Studio
产品简介
数据治理中心DataArts Studio与其他服务的关系
配置模式生成API
3.进入“API管理”页面,单击“新建”,填写API基本信息。详见下表: API基本信息配置说明 API名称支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。 API目录一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。您可单击“新建”进行新建,也可选择新建API目录已创建的API分组。请求Path API访问路径,例如:/v2/{project_id}/streams。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
创建API
配置模式生成API
删除环境
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“环境变量”区域,选择环境。步骤 5 在待删除的环境所在行,单击“删除”,弹出“删除环境”对话框。说明仅在环境未被API发布时,支持删除。步骤 6 单击“确定”,完成环境管理信息。

来自：
帮助文档
API网关
开放API网关
环境管理
删除环境
重置Secret
重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。前提条件已创建凭据。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > 凭据管理”。步骤 4 单击凭据名称 ,进入凭据详情页面。步骤 5 单击“重置Secret”。步骤 6 在弹窗中单击“确定”。

来自：
帮助文档
API网关
调用API网关
应用管理
重置Secret
删除凭据
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > 凭据管理”,进入凭据管理信息页面。步骤 4 通过以下任意一种方式,进入“删除凭据”对话框。在待删除的凭据所在行,单击“删除”。单击“凭据名称”,进入凭据详情页面,在右上角单击“删除”。说明仅在应用未绑定任何API时,支持删除,否则请先解绑API。步骤 5 单击“确定”,完成凭据的删除。

来自：
帮助文档
API网关
调用API网关
应用管理
删除凭据
删除签名密钥
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在策略管理页面,选择“签名密钥”,进入密钥策略列表。步骤 5 通过以下任意一种方法,弹出“删除密钥策略”对话框。在待删除的密钥策略所在行,单击“删除”。单击“密钥策略名称”,进入签名密钥策略详情页面。在右上角单击“删除”。说明仅在签名密钥未绑定任何API时,支持删除,否则请先解绑API。

来自：
帮助文档
API网关
开放API网关
签名密钥
删除签名密钥
删除负载通道
说明如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。前提条件已创建VPC通道。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 单击“负载通道”页签,进入到负载通道列表页面。步骤 5 通过以下任意一种方法,弹出“删除负载通道”对话框。在待删除的负载通道所在行,单击“删除”。单击“负载通道名称”,进入负载通道详情页面。

来自：
帮助文档
API网关
开放API网关
负载通道
删除负载通道
删除自定义认证
已在API中使用的自定义认证无法被删除。前提条件已创建自定义认证。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“自定义认证”页签,在待删除的自定义认证所在行,单击“删除”,弹出“删除自定义认证”对话框。步骤 5 单击“确定”。

来自：
帮助文档
API网关
开放API网关
自定义认证
删除自定义认证

天翼云最新活动

818算力跃迁·礼遇盛夏

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

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

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

云上钜惠

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

算力套餐

让算力触手可及

天翼云AI产品特惠

8折特惠，新老同享不限购

中小企业服务商合作专区

国家云助力中小企业腾飞，高额上云补贴重磅上线

出海产品促销专区

爆款云主机低至2折，高性价比，不限新老速来抢购！

天翼云电脑专场

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

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

弹性云主机

物理机

GPU云主机

镜像服务

轻量型云主机

弹性高性能计算

天翼云CTyunOS系统

训推服务

模型推理服务

推荐文档

术语解释

创建消费组

系统访问

产品详情

云主机购买流程

修改自动备份策略