基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
DeleteApiProduct-删除API产品
删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
API概览
SetTrafficControlApis 添加指定流控策略与API的绑定 添加指定流控策略与API的绑定。DescribeTrafficControls 查询流控策略列表及详情 查询用户自定义的流控策略列表及详情信息，支持条件查询。DescribeTrafficControlsByApi 查询API绑定的...
DetachApiProduct-解除API与API产品的绑定关系
解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
名词解释
参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则对无效请求进行过滤。常量参数 不需要用户传入的，但是后端服务需要始终接收的常量参数。系统...
SetSignatureApis-绑定签名密钥与API
添加指定签名密钥与API的绑定。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
HTTPS 证书报错
只在与 API 提供商无法提供兼容性更好的主流 SSL 证书，且安全风险可控的前提下，可以考虑使用此方法。2.API提供者的 SSL 证书过期 提供者的 SSL 证书过期。解决方案 联系 API 提供者，要求其更换 SSL 证书。程序中忽略检查 SSL 证书有效性...
SetIpControlApis-绑定IP访问控制与API关系
添加指定IP访问控制与API的绑定关系。接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...
函数计算
说明 如果函数计算与 API 不在同一地域，将通过公网访问您的函数计算服务，产生流量费用。若您对数据安全和网络延迟有较高要求，请选择API 与函数计算为同一地域。创建和定义API。在“定义API后端服务”步骤中，如下图所示：后端服务类型：...
导入标准OAS定义
标准OAS2.0格式与API网关的对应 说明 本章节重点介绍OAS 2.0的格式定义与API网关的API定义有对应的映射字段，对于没有对应映射的OAS中的定义，不会影响API的导入。Swagger Object：BasePath：对应分组的BasePath，导入时需要认证；Schemes...
RemoveIpControlApis-解除API与IP访问控制的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
SetTrafficControlApis-添加指定流控策略与API的绑定
添加指定流控策略与API的绑定。接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
管理 CORS 规则
如果需要再度开启该 API，则将规则与 API 重新绑定即可。编辑 CORS 规则 打开规则编辑界面有以下两种方式：在规则列表页，单击规则右侧 操作 列中的 编辑 即可打开编辑规则界面。单击规则名进入规则详情页后，单击页面右上方的 编辑 即可...
RemoveSignatureApis-解除API与后端签名密钥的绑定
解除API与后端签名密钥的绑定关系。接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
使用 RAM 管理 API
relative-id：与 API 网关相关的资源描述部分，这部分的格式描述支持类似于一个文件路径的树状结构。格式：acs:apigateway:$regionid:$accountid:apigroup/$groupId 示例：acs:apigateway:*:*:apigroup/cbd157704e624ab58a204fd3e0b5ad79 ...
使用SDK调用API
1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在 调用API 的 已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...
DeleteApp-删除应用
接口说明 此功能面向调用 API 的用户 注意删除之后不可恢复，与 API 的授权关系也不可恢复 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
基于Swagger完成API网关与用户CICD流程整合
本文主要用于介绍用户CICD流程与API网关整合的通用方法实践。该方法的核心是以swagger为桥接，通过API网关的ImportSwagger接口来完成您的API的自动创建和更新。一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关...
新功能发布记录
全部 2021-06 功能名称 功能描述 发布地域 相关文档 新增BasePath 支持在分组上设置BasePath，分组内所有API访问都需要组合BasePath与API自身的Path 全部 Swagger导入支持Array数组 Swagger导入支持Array数组 全部 全链路日志 支持全链路...
创建 CORS 规则
跨域访问是指请求一个与自身资源不同源（不同的域名、协议或端口）的资源。不同源可以是不同的域名、协议或端口。浏览器出于安全考虑设置了同源策略，限制了从...后续操作 CORS 规则创建后，您可通过 绑定 API 功能将规则与 API 进行绑定。
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
后端路由
backend:后端描述，与API网关的Swagger标准保持一致，后端在原有API的后端上覆盖backend配置后处理，如果覆盖后的backend不完整，会提示客户端 X-Ca-Error-Code:I504RB，当看到这个错误时，请检查自己的backend配置是否完整，关于Backend...
断路器插件
降级后端配置 当断路器打开时，可以通过配置 downgradeBackend 来配置断路器打开后的返回，返回的结构与API网关的Swagger结构一致，详细请参考文档通过 导入Swagger创建API，目前支持的后端类型及配置样例如下：HTTP后端-backend:type:...
授权API
API授权方案 API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。DataWorks数据服务默认会对工作空间下的API添加“阿里云APP认证”的认证方式，并授权给与工作空间同名...
数据服务入门
数据服务与API网关为您提供安全、稳定、低成本、易上手的数据开放共享服务。更多数据服务的介绍，详情请参见 数据服务概述。进入数据服务 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应工作空间后单击 进入数据...
管理API
说明 由于在DMS控制台定义的API与API网关集成，因此发布后的API，可在API网关的控制台中看到，但不可编辑。步骤三：测试API API发布后，您可以在API测试页签下，查看调用API的返回结果是否符合预期。在 API测试 页签下，单击下拉列表选择...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及...导入失败，大多情况是因为导入的 API 数据与当前选择的租户、工作空间下的现有 API 数据重复冲突了。您可以修改本地文件中相应的 API 配置数据，继而尝试重新上传导入。
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
Zookeeper
3.创建VPC融合专享实例 由于API网关与Zookeeper、与注册在Zookeeper上的微服务应用之间仅支持内网通信，而传统的专享实例又无法实现自定义内网通信，因此我们提供了一种新型的VPC融合专享实例，以支持API网关通过内网打通用户的VPC，融合...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
搭建无服务器应用之手机号归属地查询
说明 建议API网关与函数计算选择在同一区域，以免走公网响应时间变长。API网关上设置的超时时间应不小于函数执行的时间，以避免API网关提前终止请求响应。返回结果示例。参考手机号归属地提供商的返回值，填写到API网关中，代码如下：{...
- 产品推荐
- 这些文档可能帮助您