API 网关

API 网关(API Gateway)提供高性能、高可用的 API 托管服务,帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用,提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作,即可快速、低成本、低风险地开放数据...

简介

业务限制资源规格限制说明在API网关中,对每用户创建的API分组、API个数都有限制,对用户经过API网关调用开放的API也有限制。详情请参考官网文档对使用限制的说明 使用限制。在接口说明部分,凡出现与官网上给出的限制发生矛盾时,均以...

名词解释

参数映射 用户实际请求的参数API服务后端参数不一致时,支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则,由网关根据规则对无效请求进行过滤。常量参数 不需要用户传入的,但是后端服务需要始终接收的常量参数。系统...

参数映射与校验规则

使用逗号分隔:比如江,河,湖,海,如果输入值不在列表中,会报错误码:I400IP:Invalid Parameter:.``如果参数类型设置为ARRAY数组类型,只有query,formData,header三个位置的参数支持数组格式,数组参数的校验规则对可以对每个数组元素生效...

创建 API

创建API即录入API的定义,需要录入API的基本信息、服务信息、请求信息、和返回信息,然后对创建的API进行调试,及进行安全配置。经测试证明API可用后,发布上线供用户使用。1 定义 APIAPI网关控制台中API列表页面,单击创建API,即进入...

功能概览

API网关支持以下功能 API 生命周期管理 覆盖...支持swagger导入导出,支持swagger 2.0标准,结合管控API有效与您的运维系统、CICD系统对接;支持Terraform编排;API市场 支持以API商品的方式上架到阿里云API市场,并提供多种计费方式。

流量控制插件

unit:SECOND#默认的流控单位,支持:SECOND,MINUTE,HOUR,DAY apiDefault:50#API整体流控 appDefault:20#(选)针对每APP的流控值,不大于API整体流控 userDefault:30#(选)针对每用户的流控值,不大于API整体流控 specials:#(选)特殊流...

概述

1 如何创建API创建API的方式有三种:通过控制台创建API、通过管控API创建API、通过导入Swagger创建API通过控制台创建API登录阿里云API网关控制台,左上角选择地域,然后在分组中创建API。具体步骤参考创建 API使用管控API创建API可以通过...

为什么会提示我Path冲突?

Path是API的的标识,同一分组HTTP Method+Path...动态参数与其他此位置的任何固定参数冲突,如存在一个API的Path为instance/disk/[disk],新录入一个API的Path为instance/disk/abcd123时,[disk]和abcd123会被识别为相同参数,会提示Path冲突。

修改 API

此接口面向开放API的用户 该接口需要全量更新,不支持部分参数更新 修改ApiName时需要注意,同一个分组内API不允许重名 修改RequestPath时需要注意,同一个分组内Path不允许重复 该接口调用的QPS限制为:单用户QPS不超过50 调试 您可以在...

创建 API

API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。设置ForceNonceCheck为false,则不检查。创建API时默认为false。DisableInternet Boolean 否 true 设置DisableInternet为true,...

错误代码表

Failed To Invoke Backend Service 500 底层服务错误 API 提供者底层服务错误,建议重试,如果重试多次仍然不可用,联系 API 服务商解决。Service Unavailable 503 服务不可用 建议稍后重试。Async Service 504 后端服务超时 建议稍后重...

参数访问控制插件

4.使用限制参数定义个数不超过160。单个表达式的字符不超过1024字符。插件配置大小限制为50KB。最大允许的rules条为160条。说明 当这插件绑定至共享实例API时,参数定义及rules只有前16条生效,绑定至专享实例API时全部生效)

产品优势

API网关提供了API认证、参数清洗、全链路签名、CA证书、访问控制、流量控制、内网访问等多种安全机制,并且可以与WAF、DDoS高防IP、IDaaS等结合使用,形成全链路API安全保障方案。丰富的集成能力 与阿里云的计算产品、大数据产品、AI产品、...

get_rts_funcs

函数原型 唯一对外可见的API,通过这个API可获取其他API的指针。const struct rts_glue_funcs*get_rts_funcs(int version);参数介绍 参数 解释 version api兼容版本(必须是2)。返回值 调用成功,返回rts_glue_funcs指针。调用失败(一般...

使用VPC内资源作为API的后端服务

2.3 创建API创建API的流程与其他类型API方式一致,创建API分组以及定义API可参考创建 API创建应用以及授权可参考创建后端服务为VPC内资源的API2.4 测试API可以到通过以下方式测试您的API调试API下载SDK使用简单认证(AppCode)方式调用API2...

发布API商品

在完成服务商入住API集市后,API商品上架过程分成两步骤:步骤一:在API网关上进行API的配置,并发布在API网关上;步骤二:在云市场服务商控制台上进行API商品的配置,包括商品介绍、售卖信息等。本文目标:帮助合作伙伴快速了解API商品...

通过导入Swagger创建API

现在,API网关支持导入Swagger 2.0的文件来创建API,您可以参考ImportSwagger,或在控制台上进行操作,入口见下图:API网关的Swagger扩展基于Swagger 2.0,可以创建API实体的Swagger定义,并将Swagger导入API网关用于批量创建或者更新API...

使用限制

限制项限制描述使用API网关服务的用户限制用户需实名认证用户创建API分组数量限制-每账号下,每Region的API分组(含绑定域名和未绑定域名的分组)的总数上限200;每账号下,每Region默认最多创建5未绑定域名的API分组,如果在...

API网关灰度发布最佳实践

用户需要先在API上绑定配置如下的JWT插件-parameter:X-Token#从指定的参数中获取JWT,对应API参数 parameterLocation:header#API为映射模式时选,API为透传模式下必填,用于指定JWT的读取位置,仅支持`query`,`header` claimParameters:#...

概述

完成API的创建和发布之后,本章节重点会从客户端(如其他业务系统的代码、手机...作为您调用API的身份,每APP有一对AppKey和AppSecret密钥对,AppKey需要在请求时作为参数在Header传入,AppSecret需要用于计算请求签名。详情参考API授权。

更新日志

财务单元OpenAPI-2019-10-18(October 18,2019)企业财务功能中的财务单元现在可以使用API进行操作,包括以下功能:创建,编辑或者删除财务单元查询财务单元所包含的资源添加或修改财务单元下的资源通过文档查看API相关的参数和调用方法。...

删除 API 分组

此功能面向API提供者分组下存在API时,分组不删除,须先删除分组下的API删除分组后,系统分配给此分组的二级域名自动生效删除不存在的分组时,会返回删除成功该接口调用的QPS限制为:单用户QPS不超过50 请求参数 名称 类型 是否必须 描述...

新功能发布记录

提高到32M(共享实例目前只支持8M)全部支持从Form的multipart中读取参数支持从Form的multipart中读取参数全部API网关监控 提供基于Region、分组的API调用监控统计数据全部API网关监控2020-08功能名称功能描述发布地域相关文档API服务后端...

创建 API 分组

API分组描述,不超过180字符 返回参数 名称 类型 描述 RequestId String 请求唯一标识 GroupID String API分组 ID,系统生成,全局唯一 GroupName String API分组名称 SubDomain String 系统给分组绑定的二级域名,用于测试API调用 ...

下线 API

此功能面向开放API的用户,和发布API相对应 将指定环境中运行的指定API从运行环境里删除,需要一定的时间,最长不超过5s API下线后将不能被调用(指定环境)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

创建后端为函数计算的API

在本例中,入参请求方式选择入参透传,表示发送过来的参数API网关不做处理,直接透传给函数计算。步骤7 定义API后端服务信息本环节是定于API网关收到client端的请求后,进行何种参数映射、处理,以及连接哪个后端地址。本例中的后端服务...

概述

4.开发者指南(OpenAPI)插件管理相关的OPENAPI如下:创建插件:CreatePlugin修改插件:ModifyPlugin删除插件:DeletePlugin查询插件:DescribePlugins绑定API插件:AttachPlugin解绑API插件:DetachPlugin查询插件绑定的APIs:...

删除 API 定义

请求参数 名称 类型 是否必选 示例值 描述 ApiId String 是 d6f679aeb3be4b91b3688e887ca1fe16 API编号 GroupId String 是 123 分组编号 Action String 否 DeleteApi 操作接口名,系统规定参数,取值:DeleteApi。返回数据 名称 类型 示例...

查询已发布 API 列表

此功能面向开放API的用户 请求参数 名称 类型 是否必须 描述 Action String 是 操作接口名,系统规定参数,取值:DescribeDeployedApis GroupId String 否 指定的分组编号 StageName String 是 环境名称,选值:RELEASE:线上 TEST:测试...

创建API接口

在新建API的添加API参数页面,设置请求参数和返回参数,并单击保存或者保存并调试,如下图所示。说明 保存保存当前设置,保存并调试跳转至调试API页面。单击保存并调试进入调试API页面,输入调试参数值并选择返回参数。单击运行调试,...

实例类型与选择指南

IP地址固定Ipv6入口/出口能力不支持支持后端最大超时时间限制30s90sAPI网关自调用不支持支持请求包体限制8MB32MB断路器插件默认配置,不定制定制自定义配置Caching每用户30MB参照实例规格专享实例插件元数据及数量限制单个插件元数据...

发布 API

此功能面向开放API的用户,定义的API只有发布到运行环境,才能被调用 API发布到集群里需要一定的时间,最长5秒后生效 该接口调用的QPS限制为:单用户QPS不超过50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

快速切换 API 版本

此功能面向开放API的用户 历史版本号通过DescribeHistoryApis接口获取 发布超过1次的API才可以切换 切换针对的是运行中API,切换操作不可逆且迅速生效,需谨慎;切换有一定的延迟性,最长不超过5s 切换本质上也是一次发布操作,需要说明...

调用API商品

本文适用于您在云市场上购买API商品成功后,如何调用APIAPI认证方式概述 在调用API商品时,首先您需要了解采用哪种API认证方式,云市场API商品的认证方式主要以下两种方式。两种方式同时使用,您可以根据不同情况来选择。简单身份认证...

CORS 配置

本文列出了 CORS 跨域资源共享相关的 OpenAPI 及其请求参数、返回参数。创建 CORS 配置sofa.apigateway.cors.create 用于创建 CORS 配置。请求参数名称类型是否必填示例描述paramCorsInfoVO否-CORS 配置信息tenant_idSTRING否TSCPDICNT租户...

API报警设置

1.关联资源API网关监控报警功能可以满足您多样化的业务需求,监控报警的指标包括:HttpStatusCodeAPI响应时间API总体请求次数流入流量流出流量创建报警规则关联资源时,有三种方式,如下:手动关联同一Region下的一个API或者多个API。...

创建后端服务为VPC内资源的API

在本例中,入参请求方式选择入参透传,表示发送过来的参数API网关不做处理,直接透传给后端VPC。步骤6 定义API后端服务信息本环节是定于API网关收到client端的请求后,进行何种参数映射、处理,以及连接哪个后端地址。本例中的后端服务类型...

查询 API 定义

描述查询API定义 此接口面向开放API的用户用于查询指定API的定义 请求参数 名称 类型 是否必须 描述 Action String 是 操作接口名,系统规定参数,取值:DescribeApi GroupId String 否 API所在的分组编号 ApiId String 是 API的Id标识 ...

API授权

前提条件API认证方式为"阿里云APP认证"1 应用(APP)应用(APP)是调用API的身份,每APP有一对AppKey和AppSecret密钥对,AppKey需要在请求时作为参数在Header传入,AppSecret需要用于计算请求签名。详细摘要签名的计算传递方式,请查看...
< 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 轻量应用服务器 SSL证书 商标 物联网无线连接服务 短信服务
这些文档可能帮助您
在线扩容云盘(Linux系统) Web端上传介绍 Redis命令支持概览 什么是云数据库Redis版 通过redis-cli连接Redis 存储类型介绍

新品推荐

你可能感兴趣

热门推荐

新人福利专场 阿里云试用中心 企业支持计划 飞天会员助力企业低成本上云 智能财税30天免费试用 云解析DNS新用户首购低至36元/年起 ECS限时升级特惠6.5折