二、兼容性说明 API网关与Swagger规范在定义API时存在一定差异性，包括：2.1 Swagger参数类型与原有API网关类型的对照表 Swagger类型 API网关类型 支持的校验参数及规则 type:integer format:int32 Int mininum maxnum type:integer format...
导入标准OAS定义 API网关支持导入OAS 2.0和OAS3.0格式的API定义，也支持导入扩展后的OAS定义，您可以快速将现有系统的API接入网关。使用现有API定义文件，无需修改就可以在API网关中配置并管理这些API。详细内容包括：标准OAS2.0格式与API...
勾选导出API网关扩展字段后，在API网关定义API以外的内容，如绑定的插件、授权的APP、分组的域名、后端服务在各环境上的定义等，均不会被导出。示例 如下为使用API网关提供的分组导出带有扩展定义的OAS2.0内容：swagger:'2.0' info:...
本章节汇总了原API网关中API定义相关问题。API定义问题 API网关是否支持gzip数据压缩，是否需要添加请求头Accept-Encoding？用户传了一个未定义的参数，网关将如何处理？后端服务是否可以使用HTTPS？ API基础定义是什么？为什么要填写API...
OAS 版本号：oas2 oas3 oas2 WithXExtensions boolean 否 是否导出 API 网关拓展定义 true PageNumber integer 否 导出分组下所有 API 时的分页页码 1 返回参数 名称 类型 描述 示例值 object Data string Swagger 文件经 base64 编码后的...
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括如下过程：选择目标分组和全局信息。录入OAS 2.0格式的API定义，或OAS 3.0格式的API定义。进行预检并根据检查结果进行调整...
ContentType 头的取值策略：DEFAULT：使用 API 网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的 ContentType 的头 DEFAULT Path string API 请求路径/api/offline/cacheData ServiceName string 函数计算定义的 ServiceName ...
API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。设置 ForceNonceCheck 为 false,则不检查。修改时，不设置则不修改原来的取值。true DisableInternet boolean 否 设置 ...
API 网关收到这个参数后会校验这个参数的有效性，同样的值，15 分内只能被使用一次。可以有效防止 API 的重放攻击。设置 ForceNonceCheck 为 false,则不检查。修改时，不设置则不修改原来的取值。true DisableInternet boolean 否 设置 ...
ContentType 头的取值策略：DEFAULT：使用 API 网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的 ContentType 的头 DEFAULT Path string API 请求路径/api/offline/cacheData ServiceName string 函数计算定义的 ServiceName ...
可选值：RELEASE:线上 TEST:测试 RELEASE StageAlias string 环境别名 线上 HistoryVersion string API 定义的历史版本 20210915101416294 ApiName string API 名称 v2_role_assign RegionId string 地域 ID cn-qingdao 示例 正常返回示例 ...
{"Statement":[{"Action":["apig:*"],"Resource":"acs:apig:*:*:gateway/gw-cpnx*","Effect":"Allow"}],"Version":"1"} 示例2：授予RAM用户对云原生API网关API列表api-cpo22t5lhtgxxxxxx的读写权限。{"Statement":[{"Action":["apig:*"],...
本文介绍API 网关使用自定义权限策略的场景和策略示例。什么是自定义权限策略 在基于RAM的访问控制体系中，自定义权限策略是指在系统权限策略之外，您可以自主创建、更新和删除的权限策略。自定义权限策略的版本更新需由您来维护。创建...
步骤一：定义 API 在API网关控制台中API列表页面，单击创建API，即进入API的创建和定义流程。定义请求的基本信息 参数 描述 分组 分组是API的管理单元，创建API之前您需要先创建分组，选择分组即选择Region。API名称 所创建的API的名称。...
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
名称 类型 描述 示例值 object HTTP API 定义的响应格式 contentType string 内应内容类型。application/json items array object 响应定义。object 响应体 code integer 响应码。200 example string 示例值。{"result":"ok"} description ...
应用场景 API网关访问用户的函数计算，通过服务关联角色功能获取访问权限。AliyunServiceRoleForApiGateway介绍 角色名称：AliyunServiceRoleForApiGateway 角色权限策略：AliyunServiceRolePolicyForApiGateway 权限说明：{"Version":"1",...
名称 类型 描述 示例值 object HTTP API 定义的响应格式 contentType string 内应内容类型。application/json items array object 响应定义。object 响应体 code integer 响应码。200 example string 示例值。{"result":"ok"} description ...
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
specContentBase64 string Base64 编码的 API 定义。b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6...
导入HTTP API，支持将OpenAPI 2.0和 OpenAPI 3.0.x版本的定义文件导入为REST类型的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表...
以API网关提供的SDK为例，在下面代码中配置：上文提到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：APIGatewayBackendTimeout配置生效优先级 您可以在API网关控制台的各个地方配置API的后端服务超时...
本策略由API 网关定义和使用，您不能修改或删除，请勿将其授权给服务关联角色之外的RAM身份。查看策略详情 授权操作参考 RAM 身份默认没有任何权限，需要由阿里云账号管理员为其授权后才能访问阿里云账号下的资源。为保证资源的数据安全，...
配置项 示例值 后端配置 选择 自定义后端服务 后端服务类型 选择 VPC VPC授权名称*-microservice 后端请求Path/HTTP Method GET 后端超时 10000 说明 本步骤是定义API网关收到client端的请求后，如何参数映射以及连接哪个后端地址。...
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。...3.查看分组同步历史 登录API网关控制台，在左侧导航栏选择 API管理 分组管理，单击 分组同步记录，即可查看分组同步的历史记录，并可以单击操作栏查看分组同步的详细信息。
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端配置选择 使用已有的后端服务，后端服务类型选择 服务发现，后端服务选择之前创建的后端服务，后端请求的Path、...
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端服务类型选择OSS，由于前面定义API请求方式选择了GET，后端定义里的Action选择GetObject，推荐您选择同区域下的OSS...
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端配置选择 使用已有的后端服务，后端服务类型选择 服务发现，后端服务选择之前创建的后端服务，后端请求的Path、...
定义API后端服务：本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址，这里我们使用之前创建的后端服务进行说明：首先在后端配置选择使用已有的后端服务；然后选择后端服务类型，控制台会自动过滤您...
名称 类型 描述 示例值 object HttpApiRequestContract headerParameters array 请求头参数定义。HttpApiParameter 请求头参数定义。queryParameters array Query 参数定义。HttpApiParameter Query 参数定义。pathParameters array 路径...
ContentType 头的取值策略：DEFAULT：使用 API 网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的 ContentType 的头 DEFAULT Path string API 请求路径/api/offline/cacheData ServiceName string 函数计算定义的 ServiceName ...
3.2.2.API定义导入 原API网关和云原生API网关都支持标准的OAS协议，您只需要将API定义从原API网关上导出成API定义文件（OAS协议），然后在云原生API网关进行导入就可以：在原API网关导出整个分组的API定义，文档参考 导出标准OAS定义。...
API网关实例选择及分组 实例选择 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡，API网关支持Serverless 实例和专享实例两种，适用于不同的使用场景：专享实例适用场景：提供高性能和高SLA保证，...
通过 API 网关可以使 API 适配多端，企业只需要在 API 网关调整 API 定义，无需做额外工作。企业只需维护一个服务体系，即可面向多端输出；只需调整API定义，即可实现对APP、设备、web端等多种终端的支持；避免多个场景多套API，大幅降低...
本文讲述API网关的参数以及条件表达式的使用。1.概述 在插件中，支持用户从当前的 请求、应答 或 系统上下文 中获取参数，并使用自定义的条件表达式对参数进行判断，本文描述参数的定义方法与条件表达式的书写方法。2.参数的定义 2.1.定义...
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入控制台页面，在左侧导航栏中选择 API 发布 数据...
针对各种业务需求，API网关和云原生API网关提供相关的实践教程，您可以根据需求选择对应的最佳实践教程进行参考。API网关 API网关最佳实践请参见 API网关实践教程。云原生API网关 云原生API网关最佳实践请参见 云原生API网关实践教程。