产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
小程序权限控制
为了对 App 中小程序的可访问范围进行权限控制，您可在 mPaaS 控制台中为小程序添加 服务器域名白名单、API 调用白名单 以及 内嵌 WebView 域名白名单。开启了下图中的 小程序权限控制开关 后，只有加入白名单里的资源才可被当前小程序访问...
数据地图概述
查找表、代码和API 在首页查找 您还可以通过 首页 中的 API 类目下展示的近期浏览的API、热门浏览的API、热门调用的API等列表快速获取相应的API，或者在搜索框中输入关键字搜索目标API，详情请参见 通用数据查询与管理。您可以通过 首页 中...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
QueryPriceEntityList-商品定价对象列表查询
本API是用来查询一个商品下有哪些定价对象。定价对象是用来计量和计算费用的最小产品能力。接口说明 本 API 是用来查询一个商品下有哪些定价对象。定价对象是用来计量和计算费用的最小产品能力。调试 您可以在OpenAPI Explorer中直接运行该...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
错误代码表
当客户端收到的应答中 X-Ca-Error-Code 头不为空，表示应答码由API网关产生，错误码由一个6位长度的字符描述，请参考下表，而 X-Ca-Error-Message 表示错误的应答信息，用于描述该场景下更详细的一些错误信息。如果 X-Ca-Error-Code 头为空...
导入标准OAS定义
如果API定义的入参请求模式为透传模式，没有使用API网关扩展字段的情况下，API定义中请求部分和后端服务部分的请求方法，请求路径，参数定义保持一致；对于body位置的参数，如果参数类型为引用类型，不会在API网关的API定义中体现，只会在...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
发布API商品
应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示：注意事项：除了在调试API的页面中进行调试之外，为了保证...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
函数计算内网访问API网关
本文介绍在函数计算中如何通过VPC访问API网关，包括两种情况：在同一Region，以及在跨Region情况下如何访问。1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，...
AddIpControlPolicyItem-增加IP访问控制策略
接口说明 调用该接口时请注意：此功能面向 API 提供者。增加该策略后，所有绑定该访问控制的 API，即时生效。一个 IP 访问控制下最多添加 100 条策略。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，...
数据服务
默认情况下，API最多只会返回2000条查询结果。因此当API返回结果有可能超过2000条时，请开启返回结果分页功能。当API无请求参数时，通常返回结果会比较多，系统会强制开启返回结果分页。说明 当数据服务的API在编辑页面右侧导航栏的 返回...
小程序场景下直接调用
视觉智能开放平台的API接口推荐使用SDK...这里只是为了小程序端演示流程，所以将代码写在了小程序端*真正上线不建议将ACCESS_KEY_ID和ACCESS_KEY_SECRET写在小程序端，会有泄漏风险，建议将请求API接口代码写到您的服务端*请求银行卡识别：...
绑定/解绑 API
说明 一个规则下可绑定多个 API，但一个 API 只可绑定一个规则。解绑 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，可看到已绑定的 API。解除 API 绑定。单个解绑：找到需要解绑的 API，...
使用向导模式创建三方API
加密身份认证：通过加密算法计算一个签名并放在请求的Header中即可调用API，具备更高的安全性，适用于API共享后，应用开发场景下API的调用。标签 自定义，可选。描述 针对该API增加的描述信息，自定义，必选。在 参数配置 区域，配置API...
使用SQL模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，减少资源操作成本。SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建...
使用SQL模式创建数据服务API
数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，减少资源操作成本。SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询，通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建...
创建空间服务API
加密身份认证：通过加密算法计算一个签名并放在请求的Header中即可调用API，具备更高的安全性，适用于API共享后，应用开发场景下API的调用。标签 自定义，可选。描述 针对该API增加的描述信息，自定义，必选。空间数据元信息 坐标系 需创建...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
授权API
本文为您介绍如何对API进行授权及不同场景下API的授权方案。前提条件 仅支持对已发布的API进行下线、授权和变更协议等操作，详情请参见 发布API。进入API管理页面 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
自定义 JSAPI
要从页面发起 Native 功能调用，例如显示一个 ActionSheet，或显示联系人对话框，您需要扩展一个 JavaScript API（JSAPI）。使用 JSAPI，可以让您在 H5 页面增加 Native 功能调用入口。通过实现自定义 JSAPI 类中的 handler 方法，以 ...
API 属性说明
同一个 工作空间下 API 名称不能相同。是否基于已有API创建 否 默认关闭 开启后可选择已创建的 API 作为模板。API 分组 是 用于将 API 进行逻辑的分组，分组下的 API 相同的分组 ID 进行隔离。同一个环境下，API 分组名称不能相同。API ...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
为分组绑定插件
1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效，如果API的数量较多，那么绑定插件可能会变得繁琐且耗时，因此我们提供了...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
添加Open API数据源
重要 如果您的 我的可视化 页面内还没有创建任何可视化应用，请参见 使用模板创建PC端可视化应用，创建一个可视化应用。在画布编辑页面，单击画布中的某一组件。如果画布中还没有组件，请先添加组件，详情请参见 添加资产。在画布右侧的...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
添加API数据源
重要 如果您的 我的可视化 页面内还没有创建任何可视化应用，请参见 使用模板创建PC端可视化应用，创建一个可视化应用。在画布编辑页面，单击画布中的某一组件。如果画布中还没有组件，请先添加组件，详情请参见 添加资产。在画布右侧的...
创建并管理业务流程
每一个业务流程下均包括API、函数和服务编排三个类目，分别存放您创建的API、函数和服务编排。新建业务流程 进入 数据服务 页面。登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应工作空间后单击 进入数据服务。在 ...
DescribeDeployedApi-查询API在指定环境中的定义
查询指定API在指定环境中正在运行的定义，是真正在指定环境中生效的定义，可能跟正在编辑中的定义不同。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
API报警设置
1.关联资源 API网关监控报警功能可以满足您多样化的业务需求，监控报警的指标包括：HttpStatusCode API响应时间 API总体请求次数 流入流量 流出流量 创建报警规则关联资源时，有三种方式，如下：手动关联同一Region下的一个API或者多个API...
压力模型
最大RPS 在RPS模式下，摸底的是单API（接口）的服务端吞吐能力，故需要给每个API设置 最大RPS 与 起始RPS。起始RPS 设置单API的起始RPS。批量设置 并发模式和RPS模式均可以使用批量设置。选中需要设置的所有串联链路或API。单击右侧的 批量...
DescribeApiHistory-查询历史版本详情
网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成...
- 产品推荐
- 这些文档可能帮助您