功能发布记录
告警设置 2018-07-27 OpenAPI发布 Web应用防火墙针对常见控制台配置操作开放对应API接口，方便用户执行批量化操作。API概览 2018-05-29 推出业务数据大屏试用服务 Web应用防火墙推出业务数据大屏试用，方便用户及时了解网站业务全貌。大屏...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
发布与使用
如果开发者在开发Web可视化应用时使用了未发布的个人组件，则发布Web应用后，该组件在Web页面是不可见的。发布个人组件 单击 组件开发 页面右上角的 发布。输入组件发布的相关说明，单击 确认。个人组件发布成功后，跳转至 组件开发>个人...
API概览
系统为开发者提了一套REST风格的WebAPI服务。本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为URL请求串及请求Header参数两部分，所有请求均必须包含该两...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
版本管理
3 查询历史发布及版本切换 API在环境中的每次发布，API 网关都会进行发布历史记录，发布历史包含了版本号，发布环境，发布时间和您填写的发布说明，您可以在发布历史中查看任何一次的发布记录。3.1 查询历史发布 1.登录 API网关控制台，在...
导入导出 API
批量导出 API 在 API 发布>API 管理 页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出 按钮，即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API 在 API 发布>API 管理 页面，单击 API 列表右上方的 ...
创建 API 分组
在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击 API 分组列表右上方的 创建分组 按钮。在弹出窗口中，配置 API 分组信息：分组名称：必填，用于识别 API 分组。支持英文字母、中文、数字、下划线（_）、连字符（-），32 个字符...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
批量操作API
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
概述
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
绑定/解绑授权对象
绑定授权对象 进入 API 发布>API 管理 页面，找到待授权的 API，单击进入其详情页。在 授权对象 标签页下，单击 绑定授权对象，进入 添加授权应用 窗口。对于已添加为授权对象的订阅方应用，您可以直接在授权对象列表中搜索找到。对于暂未...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
HTTP 转 SOFARPC 入门
步骤四：创建并发布 API 在左侧导航栏单击 API 发布>API 管理 页，单击列表右上方的 创建 API。在新页面中，选择 HTTP API 类型，单击 创建。在 定义 API 步骤中，您需要配置以下信息：API 分组：必选，选择上一步创建的 API 分组。API ...
WAF接入配置最佳实践
业务是否提供Web API服务 如果提供Web API服务，不建议使用CC攻击紧急防护模式。通过分析API访问特征配置自定义CC攻击防护策略，避免API正常请求被拦截。业务是否存在注册、登录、密码找回、短信接口被刷的情况 判断是否开启数据风控防护...
新功能发布记录
当API网关新增重要功能或发现重大缺陷时，API网关后台会在维护时间段内对您的实例版本进行升级 全部 专享实例付费类型转换 支持预付费实例转为按量付费，也支持按量付费实例转为预付费 全部 后端服务支持服务发现类型的API 发布在VPC融合...
事件总线
在本例创建API的时候，认证方式选择的是“阿里云APP认证“，因此在API发布后，还需要创建APP，并将APP和API的对应关系建立好，才能够正常访问。创建应用 在API网关控制台左侧导航栏选择 API管理-应用管理，创建一个APP。可以看到阿里云APP...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
创建后端为函数计算的API
API返回内容为前面步骤中创建的函数返回内容，函数代码如下：7 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...
BatchDeployApis-批量发布API
批量发布API到预发/测试/线上环境。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
创建后端服务为HTTP的API
6 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何通过调用API网关提供的SDK，来在您的业务系统中调用发布好的API。步骤11 调用API 1、在 API调用 中找到 SDK，...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
DescribeDeployApiTask-查询发布API任务进度
查询发布API的异步任务的进度。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
test ApiUid string api 编号 86364e7c166c47ba819b3f8f95ac0913 ErrorMsg string 错误信息 Success.Request Success.StageName string API 发布的环境 RELEASE ApiName string API 名称 api_test2 示例 正常返回示例 JSON 格式 {...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
Zookeeper
8.创建应用并授予API的调用权限 应用（APP）是调用API服务时的身份，在本例创建API的时候，认证方式选择的是“阿里云APP认证“，因此在API发布后，还需要创建APP，并将APP和API的对应关系建立好，才能够正常访问。具体操作步骤可参考 授权...
Nacos
8.创建应用并授予API的调用权限 应用（APP）是您调用API服务时的身份，在本例创建API的时候，认证方式选择的是“阿里云APP认证“，因此在API发布后，还需要创建APP，并将APP和API的对应关系建立好，才能够正常访问。具体操作步骤可参考 ...
DescribeUpdateBackendTask-查询后端服务更新任务
修改后端服务在某个环境上的定义时，关联的已发布API会批量更新，该接口用来查询更新的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息...
使用 RAM 管理 API
acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
功能概览
发布和路由 提供API发布管理，线上版本一键切换；支持多环境管理，满足日常研发、预发测试、生产环境并行使用需求；支持灰度发布功能；支持参数路由，可根据HTTP请求内容创建不同的路由转发规则，提高系统灵活性；API可用性 支持API应答...
使用外部授权 API
操作步骤如下：在 API 发布>外部授权 API 页面，单击刚刚创建的外部授权 API 名称，进入其详情页。在 外部授权 API 详情>绑定的 API 标签页下，单击 绑定 API。在弹出的窗口中，选择需要绑定的 API 后，单击 确定 即可。后续如需解绑，直接...
创建授权对象
在 API 订阅者创建应用后，API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中，选择或输入相关...
VPC融合专享实例
说明 当发布API或者修改插件内容时，API网关报错形如“instance cannot connect the backend xxx.xxx.xxx.xxx.”，请检查该报错内容中提到的内网地址是否在实例的 可被访问网段 中。变更分组实例 为了方便用户将业务迁移到VPC融合类型专享...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
API网关监控
可根据API发布的不同环境（线上、预发、测试）查看监控图表。可监控指标包括：API请求次数统计 按实例统计API请求次数 流量统计（请求流量、应答流量）平均延时（API网关处理延时、后端处理延时）HTTP Status Code 占比统计 2.实例监控（仅...
DeployedInfo
描述"class="reference-link">描述 API发布信息项的类型 节点名"class="reference-link">节点名 DeployedInfo 子节点"class="reference-link">子节点 名称 类型 描述 StageName String 环境名称，取值为：RELEASE、TEST EffectiveVersion ...
创建数据模型
操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：必填，用于识别数据模型，需保证唯一性。...
- 产品推荐
- 这些文档可能帮助您