基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
对象存储
本文将快速引导您如何在API网关中，发布后端服务为对象存储（OSS）类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API...
创建后端服务为HTTP的API
首先通过npm安装API网关的Node.js示例SDK，$npm install aliyun-api-gateway-S；其次在如下的代码片段中，将YOUR_APP_KEY和YOUR_APP_SECRET填写为本例中创建的APPKey的对应信息；导入网关nodejs sdk const Client=require('aliyun-api-...
事件总线
本文将快速引导您如何在API网关中，发布后端服务为事件总线类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
API调用授权
BSS OpenAPI的权限为 bssapi:【API名称】，例如 bssapi:QueryOrder 或 bssapi:QueryInstanceBill。为了兼容控制台权限，以下表格中API对应的权限点同样可以使用。对于权限策略中，Allow或Deny一个API对应的任何一个权限点，权限策略都会...
ModifyInstanceSpec-网关实例变配
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
使用后端服务提高管理效率
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，...在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：instance/disk/[diskid]，可以与后端服务地址中的动态参数进行映射。
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
模型管理
同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的POJO类。这样可以增强用户传入参数的便利性，同时可以方便用户反序列化返回的数据。API网关模型定义基于 JSON架构草案4 的规范，但...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
导入数据模型
API 网关会从 Swagger 2.0 文件中的 Model 或 Swagger 文件 3.0 中的 Schema 解析参数名称，参数结构，参数类型并转换后导入数据模型，可直接在 API 中自动生成示例入参的 JSON，数据模型也可直接在流程编排中进行参数配置，参数映射等。...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
查看API操作历史
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
API网关中配置API安全认证
规则详情 参数 说明 规则名称 API网关中配置API安全认证 规则标识 api-gateway-api-auth-required 标签 API、ApiGateway 自动修正 不支持 规则触发机制 周期执行 触发频率 24小时 规则支持的资源类型 API资源 规则入参 PluginType 修正指导...
创建 API 分组
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...
绑定/解绑 API
在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。说明 一个规则下可绑定多个 API，但一个 API 只可绑定一个规则。解绑 API 在 CORS ...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
配置记录HTTP请求应答日志
如果需要在日志中记录API网关收到的HTTP的请求及API网关返回给客户端的HTTP应答，您可以在分组详情中进行设置。记录请求Headers：逗号分隔需要记录的Header名称（如上图所示），'*' 记录全部 记录应答Headers：逗号分隔需要记录的Header...
SwitchApi-切换指定环境中正在运行中的API定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
创建授权对象
说明 当应用创建成功后，系统会自动给应用分别配一个 APPID，可在 API 订阅>应用管理 中的应用详情页查看。对于内部系统的应用，您需要输入其 应用名称，可自动获取其 APPID 与类型。所属公司/部门：可选，用于识别应用所属的公司或部门。...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
API概览
SwitchApi 切换指定环境中正在运行中的API定义 指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。DryRunSwagger 预检查swagger 使用swagger导入swagger之前先预先检查swagger的语法是否规范。应用 API 标题 ...
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。该功能常用于多部门协同、实现参数统一规范，以及实现统一错误码等场景。操作步骤 进入 API 网关控制台页面，在左侧...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
使用SDK调用API
1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在 调用API 的 已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...
导入标准OAS定义
OperationId：对应API定义的API名称，如果存在扩展字段“x-aliyun-apigateway-api-name”则使用扩展字段中的内容作为API的名称；Schemes：对应API定义中请求部分支持的协议，优先级高于Swagger Object中的定义；Parameter Object：Name：...
绑定/解绑 API
授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。...批量解绑：若需要一次解绑当前授权应用下的多个 API，可先勾选多个 API 后，单击页面底部的 批量解除绑定，在弹出的确认框中单击 确定，即可批量解除绑定多个 API。
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您