产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
通过注册方式创建API
步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 新建API 创建方式选择对话框。在 API创建方式选择 对话框 注册API 后，单击 确定。步骤二：配置注册API的参数信息 在 ...
API 网关服务等级协议（SLA）
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
停止已对外授权API
通过停止或回收已对外授权API的方式，收回已授权的API权限。本文介绍如何停止已对外授权API。前提条件 其他账号或工作组已申请该账号或工作组API。操作步骤 登录 数据资源平台控制台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，...
停止已对外授权API
通过停止或回收已对外授权API的方式，收回已授权的API权限。本文介绍如何停止已对外授权API。前提条件 其他账号或工作组已申请该账号或工作组API。操作步骤 登录企业数据智能平台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，单击...
通过直连数据源模式创建API
步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 API创建方式选择 对话框。在 API创建方式选择 对话框，选择 直连数据源模式 后，单击 确定。步骤二：配置API参数信息 在...
名词解释
API提供方应用 和消费方相对，指接入CSB开放出服务API的提供者应用。API发布者 API提供方应用在CSB上发布服务和管理服务的用户。CSB实例 每一组CSB服务总线节点（Broker）集群被视为一个独立的CSB实例，通常负责一个业务域内能力的对外开放...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
概述
阿里云为开发者提供多种调用 OpenAPI 的方式，具体可根据业务的实际情况进行选择。推荐方式 说明 SDK 是最易于集成，且支持度最好的 OpenAPI 调用方式。各种调用方式的详细说明，请参见 阿里云SDK 阿里云CLI 云命令行（Cloud Shell）资源...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API网关中开启公网访问的API请求方式为HTTPS
应用场景 设置API请求方式为HTTPS，对信息和数据加密，用来保证数据传输的安全。风险等级 默认风险等级：高风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中开启公网访问的API请求方式设置为HTTPS，视为“合规”...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
API任务概述
通过SQL模式创建API 通过向导模式创建API 向导模式基于服务单元、Dataphin逻辑表通过可视化界面配置API参数的方式创建API，简单易上手。通过向导模式创建API 通过注册方式创建API 注册API是通过注册的方式，将已有的服务注册到服务平台进行...
通过服务编排的方式创建API
步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 新建API 创建方式选择对话框。在 API创建方式选择 对话框 组合API 后，单击 确定。步骤二：配置API的参数信息 在 新建...
数据服务
使用场景包括：最小粒度的数据输出：当企业需要对外提供数据时，相较于直接对外提供表数据，使用API的方式可以控制到行级（SQL过滤条件）和列级（查询字段），这样能帮助用户只对外暴露最小单元的数据，保障数据安全。可视化制作：对于多数...
通过向导模式创建API（服务单元）
步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 API创建方式选择 对话框。在 API创建方式选择 对话框，选择 逻辑表API-向导模式（服务单元）后，单击 确定。步骤二：...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
通过向导模式创建API（Dataphin表）
步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 API创建方式选择 对话框。在 API创建方式选择 对话框，选择 逻辑表API-向导模式（Dataphin表）后，单击 确定。步骤二：...
测试API
数据服务API、数据上报API、三方API、空间服务API 的调试方式相似，本文以数据服务API测试为例介绍如何测试API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
创建API数据源
同时，您也可以在搜索框中，输入API的关键词，快速筛选。在 新建API数据源 对话框中，配置相关连接数据源参数。配置数据源的基本信息。参数 描述 数据源名称 命名规则如下：只能包含中文、字母、数字、下划线（_）或中划线（-）。长度不能...
上线API
数据服务API、数据上报API、三方API、空间服务API 的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式...
创建API数据源
同时，您也可以在搜索框中，输入API的关键词，快速筛选。在 新建API数据源 对话框中，配置相关连接数据源参数。配置数据源的基本信息。参数 描述 数据源名称 命名规则如下：只能包含中文、字母、数字、下划线（_）或中划线（-）。长度不能...
应用场景
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
为分组绑定插件
1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效，如果API的数量较多，那么绑定插件可能会变得繁琐且耗时，因此我们提供了...
HTTPS 证书报错
证书不合法 API 提供者使用的证书其他非主流机构颁发的证书，此类证书使用浏览器访问是没有问题的，因为浏览器会自动更新根证书。但老版本操作系统的根证书对这些机构（证书颁发机构）的不信任或者信任时间已经过期。解决方案 升级客户端根...
新功能发布记录
在API网关维护一个用户的小型的认证体系，通过增删改配置在数据集的用户名和密码实时管理访问API的用户的登录凭证 全部 BasicAuth插件 流量控制插件支持插件数据集 提供一种用户可以动态修改流控规则的方式，适合在API售卖场景动态授权APP...
云市场API
设置请求头 根据对应接口的Header要求设置API的请求头。参数编写 填入参数。注意 参数编写 文本框不可置空。如果不设置参数，请在 参数编写 文本框中输入 {}。根据云市场该API购买页的请求参数说明，可设置请求参数为：静态参数，即填入...
TCP连接超时时间配置
具体配置 上文说到的ClientReadTimeout需要在客户端的初始化HttpClient连接池的代码中配置，拿API网关提供的SDK举例，在下面代码中配置：上文说到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：
上线API
数据服务API的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 操作步骤 登录企业数据智能平台。在页面左上角，...
导出标准OAS定义
通过API网关的灵活性，您可以更好地管理和控制API的访问权限、流量限制和请求转发，提供高度可靠和安全的API服务。整合与协作：通过将API导出为标准OAS规范的API定义，您可以方便地与其他开发工具或平台进行集成。这样，您可以与团队成员或...
数据服务
配置方式 选择API的配置方式，支持的选项：表引导模式：通过可视化的方式选择表、字段，定义API的数据查询配置。脚本模式：通过手动编写SQL脚本+变量的方式来定义API的数据查询配置。说明 从 表引导模式 切换为 脚本模式 时，系统将提示...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
快速调试接口
2.使用 STS 临时授权 Codeup OpenAPI 支持通过 STS 临时授权的方式调用接口，使用方式参考 RAM 提供的文档 什么是STS。3.使用 AccessToken 授权（个人访问令牌）Codeup OpenAPI 支持通过 AccessToken 授权的方式调用接口。如何生成 ...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
使用SQL模式创建数据服务API
SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建数据API。前提条件 已创建云计算资源，具体操作，请参见 新建云计算资源。已创建应用，具体操作，请参见 新建...
使用SQL模式创建数据服务API
SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建数据API。前提条件 已创建云计算资源，具体操作，请参见 新建云计算资源。已创建应用，具体操作，请参见 新建...
自定义API
请求方式 自定义API的请求方法支持POST和GET。API地址 该API的调用地址。若涉及鉴权等逻辑需自己编写。编码 编码方式支持UTF-8和GBK。设置请求头 根据对应接口的Header要求设置API的请求头。参数编写 根据所选API的请求参数，输入参数值。...
配置 API
MPC API API 名称：必填，该 API 的接口名称，方便后续维护。接口描述：选填，更详细的 API 描述。接入系统：API 所属的业务系统。接口方法：API 服务端方法。接口名称：API 服务端接口。高级配置 签名校验：选择是否开启签名校验。若开启...
API安全
API安全模块支持自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务中开放的API资产，检测API风险（例如敏感数据泄露、内部接口暴露等），并通过报表还原API异常事件，提供详细的风险处理建议和API生命周期管理...
- 产品推荐
- 这些文档可能帮助您