简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API请求
功能介绍 阿里云ARMS前端监控的API请求模块，可清晰展示以下信息：每个API的成功率 API返回信息 API接口的调用成功平均耗时 API接口的调用失败平均耗时 此外，该模块还会展示上述统计数据在以下维度上的分布情况：地理 浏览器 操作系统 ...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
查看API操作历史
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
批量操作API
操作步骤 1、登录API网关控制台。2、在API网关的控制台单击左侧栏的 API管理，单击进入 API列表。3、勾选需要批量操作的API，不支持隔页勾选。目前支持的批量操作包含导出swagger、API授权、发布、下线、删除、标签、批量修改API基础配置。...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
数据报表
全栈可观测应用提供丰富的仪表盘，用于展示Web页面、小程序的性能指标、JS错误、API请求、资源访问等信息。前提条件 已接入用户体验数据。具体操作，请参见 接入Web的用户体验数据、接入小程序的用户体验数据。功能入口 登录 日志服务控制...
为分组绑定插件
3.快速使用 登录API网关控制台，左侧栏找到 开放API —— 插件管理。单击右上角创建插件，在页面中自定义插件名称，选择插件类型，配置插件规则。配置好插件规则后，点击创建，随后在插件列表中就可以看到刚刚创建的插件了。点击右侧的绑定...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
混合云API集中管理
步骤2：配置云服务路由 获取API网关的出口IP，登录API网关控制台，点击实例，找到分组所在实例获取API网关的出口地址。在CEN上配置云服务访问路由，详细步骤可参考 访问云服务。步骤3：创建VPC授权 在配置API之前，需要先在API网关控制台...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
支持 HTTPS
步骤2：绑定SSL证书 准备好以上材料，需要进行如下操作进行，登录API网关管理控制台【开放API】-【分组管理】，单击您需要绑定SSL证书的分组，查看分组详情。在绑定SSL证书，您首先需要您在API分组上绑定【独立域名】。【独立域名】-添加...
如何关闭公网访问
操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 关闭公网访问 按钮，单击确定后即可关闭公网访问。...
开通IPv6
操作步骤 登录API网关控制台。点击左侧栏的 实例，选择实例所在的Region。在专享实例中找到IPv6入口能力及IPv6出访能力，点击 开通。实例开通IPv6能力后，在分组管理中找到想要开通IPv6入访能力的分组，点击进入，在分组详情页的公网二级...
创建授权对象
在 API 订阅者创建应用后，API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中，选择或输入相关...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...
HTTP自动跳转HTTPS
分组内的所有API定义的请求...操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的自动跳转开启成功。
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
导入数据模型
说明 目前 API 网关支持从 分组 和 应用 两个维度下载 SDK，以下操作步骤以 分组 角度为例。登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入 API 分组页面。在分组列表右侧单击 下载 SDK。在分组详情页配置下载 SDK 的信息...
实例变配
操作步骤 登录 API网关控制台 单击左侧的 实例 菜单，在 实例列表 的tab页面，找到要变配的实例，单击实例右侧的 升配 或 降配 链接，会跳转到实例变配页面。3.页面上选择要变配的 实例规格。4.勾选 API网关服务协议，然后单击 立即购买，...
跨域设置
添加 workspace 登录 API 网关控制台。在左侧导航栏单击 全局设置>跨域设置。说明 仅 双网关跨域通信场景 下需要维护全局的机房（网络区域）信息，如每个机房或者网络区的网关地址、注册中心的地址等，以保证网络的正常通信。该配置为全局...
创建路由规则
操作步骤 登录 API 网关控制台页面。在左侧导航栏中单击 路由规则，进入路由规则列表。单击路由规则列表右上方的 创建路由规则。在弹出的 创建路由规则 窗口中，选择或输入相关信息：规则名称：必填，用于识别路由规则的作用。后端协议类型...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
错误码
本文档列举调用物联网平台API出错时，返回的错误信息。入参数据格式错误、超出限定值、入参缺少必需参数等错误修改，请参见具体API文档的请求参数描述。系统错误码 以 iot.system、iot.Sre 开头的错误码为系统相关错误码。错误码 描述 解决...
专享实例集群
专享实例集群基本操作 创建专享实例集群 登录API网关控制台，左侧导航栏选择 专享实例集群；在列表页点击 创建专享实例集群，填入集群 名称 和 描述，点击确定；创建出来的集群状态为 就绪。添加专享实例到专享实例集群 找到刚创建好的专享...
BasicAuth插件
users:username:alice password:123456-username:bob password:666666-username:charlie password:888888-username:dave password:111111 BasicAuth插件支持插件数据集 创建插件数据集 登录API网关控制台，左侧栏点击 API管理 —— 插件...
后端内网域名解析（仅专享实例）
后端内网域名指的是在API网关中配置的后端服务地址。当后端服务地址为内网域名时，API网关提供实例级别的后端服务内网域名解析。概述 例如，后端服务使用的内网域名是通过 PrivateZone 解析时，解析只能在客户指定的VPC内生效，API网关不在...
网关结果码说明
7003 验签-时效性失败 API 请求入参 ts 时间戳超过系统设置的时间有效性。需要检查客户端时间是否为系统时间。7007 验签-缺少 ts 参数 API 请求缺少验签 ts 参数。7014 验签-缺少 sign 参数 API 请求缺少验签 sign 参数。一般情况下是客户...
错误码和状态码说明
616 登录失败。703 禁止对服务器进行内网探测。内网探测可以使用 创建可用性监控任务。HTTP协议常用标准状态码说明 状态码 含义 说明 200 请求已完成 2XX状态码均为正常。300 多种选择 服务器根据请求可执行多种操作。服务器可根据请求者来...
Python SDK调用示例
您可使用阿里云提供的Python SDK，来调用数据服务的API，从而更便捷地获取指定数据。本文以调用预置指标API为例，介绍Java SDK调用API的方法及示例。前提条件 如果需要调用预置指标API，需确保已创建产品和设备，并完成数据备份。具体操作...
Node.js SDK调用示例
您可使用阿里云提供的Node.js SDK，来调用数据服务的API，从而更便捷地获取指定数据。本文以调用预置指标API为例，介绍Node.js SDK调用API的方法及示例。前提条件 如果需要调用预置指标API，需确保已创建产品和设备，并完成数据备份。具体...
Java SDK调用示例
您可使用阿里云提供的Java SDK，来调用数据服务的API，从而更便捷地获取指定数据。您可添加包含Maven依赖的SDK，也可下载安装包到本地直接安装。本文以调用预置指标API为例，介绍Java SDK调用API的方法及示例。前提条件 如果需要调用预置...
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
- 产品推荐
- 这些文档可能帮助您