基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
AddAccountRelation-创建财务关联
创建一个财务关联关系。接口说明 1、具体财务关联业务规则参见（中国站 国际站）2、如果邀约主、子...变更历史 变更时间 变更内容概要 操作 2021-12-14 OpenAPI 返回结构发生变更 看变更集 变更项 变更内容 出参 OpenAPI 返回结构发生变更。
DescribeAuthorizedApps-查询可访问APP列表
查询当前的应用（APP）列表。接口说明 此功能面向 API 提供者 查询结果返回的所有应用（app）均可...变更历史 变更时间 变更内容概要 操作 2024-03-21 OpenAPI 返回结构发生变更 看变更集 变更项 变更内容 出参 OpenAPI 返回结构发生变更。
管理应用
在 API 订阅列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 定义、请求参数、响应示例、错误码 等详细信息。筛选 API 协议类型：单击 API 协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
2.自定义组件说明
readme.md├─src│├─api│├─config.ts│├─index.scss│└─index.tsx├─test│├─index.test.jsx│└─setupTests.js└─tsconfig.json 比较重要的文件目录如下：src/api 依赖的 API 接口定义 src/index.tsx 实现代码 src/config....
授权信息
API：是指操作对应的API接口。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。资源类型：是指操作中支持授权的资源类型。具体说明如下：对于必选的资源类型，用背景高亮的方式表示。对于不支持资源...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建后端为函数计算的API
API返回内容为前面步骤中创建的函数返回内容，函数代码如下：7 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...
获取网络栈接口
返回值定义 获取当前网络栈，返回值包含如下三种类型：如果网络支持双栈，则返回 AlicloudIPStackType.kAlicloudIPdual。如果网络只支持IPv4协议，则返回 AlicloudIPStackType.kAlicloudIPv4only。如果网络只支持IPv6协议，则返回 ...
对象存储
1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 2.创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
自定义权限
Action":["iot:UpdateProduct","iot:QueryProduct"]定义所有只读API，包含规则引擎数据流转目标产品的权限。{"Version":"1","Statement":[{"Action":["iot:Query*","iot:List*","iot:Get*","iot:BatchGet*","iot:Check*"],"Resource":"*",...
Config类
获取返回的数据格式类型（format）接口定义 获取返回的数据格式类型(format)SearchFormat getSearchFormat()返回结果 SearchFormat 类型枚举值 设置搜索返回的索引字段列表（fetch_fields）接口定义 设置搜索返回的索引字段列表(fetch_...
Zookeeper
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端配置选择 使用已有的后端服务，后端服务类型选择 服务发现，后端服务选择之前创建的后端服务，后端请求的Path、...
定义资源
可通过定义资源来实现对代码块的流控，定义资源方式如下：注解方式定义资源 抛出异常的方式定义资源 返回布尔值方式定义资源 异步调用支持 主流框架的默认适配 方式一：注解方式定义资源 通过@SentinelResource 注解定义资源并配置 ...
管理API
例如描述API返回的数据，API的应用场景。路径 路径为API调用地址的组成部分。路径只能以/开头，仅支持以英文、数字、下划线（_）、横杠（-）组成，例如/item/add。API调用地址结构示例：https://{分组域名}{路径}。路径定义为/item/test、...
DescribeApisByIpControl-查询IP访问控制绑定的API
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
DescribeApisByTrafficControl-查询指定流控策略下已...
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
Nacos
定义API后端服务 本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址。本例中的后端配置选择 使用已有的后端服务，后端服务类型选择 服务发现，后端服务选择之前创建的后端服务，后端请求的Path、...
SDK参考概述
可通过以下几种方式来定义资源：注解方式定义资源 抛出异常的方式定义资源 返回布尔值方式定义资源 异步调用支持 主流框架的默认适配 定义资源详情请参见 定义资源。配置触发规则后的逻辑 当应用触发流控、降级或系统规则时，默认抛出 ...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
如何定义Manifest
什么是Manifest Manifest的概念来源于gpt plugin，gpt plugin中Manifest是一个文件，文件存储对于一个插件的所有描述，包括插件相关的API出入参、插件作用等关键信息，大模型会根据Manifest的信息知晓当前的插件可以完成什么（What），什么...
停车场系统领域服务-服务模型定义
停车场 1.1 查询停车场信息 停车场信息包含停车场名称、停车场ID、车位总数量、车位空位数量 定义 path 版本 是否需要登录/parkingLotInfoGet 1.0.0 否 入参 无参数 出参 字段 类型 备注 code Integer 返回码 message String 返回信息 data...
服务定义与开发
定义 operationType 在服务接口的方法上添加@OperationType 注解，定义发布服务的接口名称。OperationType 有三个参数成员：value：RPC 服务的唯一标识，定义规则为 组织.产品域.产品.子产品.操作。name：接口中文名称。desc：接口描述。...
创建 API
1 定义 API 在API网关控制台中API列表页面，单击创建API，即进入API的创建和定义流程。1.1 定义请求的基本信息 参数 描述 API分组 分组是API的管理单元，创建API之前您需要先创建分组，选择分组即选择Region。API名称 所创建的API的名称。...
参数化视图
参数化视图支持传入任意表或其它变量，定制视图的行为。本文为您介绍MaxCompute ...返回参数为@ret，为它赋值的操作会在视图的脚本中进行，此处相当于定义了返回的参数名。您可以将没有 begin/end 和返回变量的视图，看作是此形式的简化形式。
实现CronHPA与HPA的协同
由于CronHPA和HPA两者无法相互感知，如果您的应用使用YAML同时配置了CronHPA和HPA，可能会出现两种配置独立工作，后执行操作覆盖了先执行操作的现象。为了解决这个问题，ACK提供了CronHPA兼容HPA的方案——当检测到两者同时存在时，将HPA...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
监控告警
ADP底座致力于帮助客户更快速更精准地发现问题，因此结合云原生应用的特性，打通了监控、告警、通知的整条链路，让客户只需要做简单的配置，就可以快速接入ADP底座的可观测能力。功能概述 ADP底座在可观测方面提供了以下能力：提供自定义...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段的取值范围等。同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的...
使用后端服务提高管理效率
定义API后端服务：本环节是定义API网关收到client端的请求后，进行何种参数映射、处理，以及连接哪个后端地址，这里我们使用之前创建的后端服务进行说明：首先在后端配置选择使用已有的后端服务；然后选择后端服务类型，控制台会自动过滤您...
发布API商品
入参定义，本例中配置了三种不同位置的参数，同时配置了默认值、示例和描述，商品发布后，入参信息会在商品页中的如下位置出现：3.3.3 定义API后端服务 这部分用于配置API网关如何访问后端服务，相关信息都不会出现在API商品信息中，更多...
联邦预处理
本文介绍了联邦预处理场景中的 API 及示例。重要 本文涉及 API 中所有的占位符，例如"$df0"，必须包含单引号或双引号。缺失值填充 函数路径 fascia.biz.preprocessing.fillna 函数定义 def fillna(fed_df:HDataFrame,columns:List[str]=...
Header
对API Header的定义，可以通过以下三种方式，使定义在不同范围内生效：设置单个API Header：该Header仅对当前API生效。设置业务会话Header：压测时，该Header将自动添加到当前业务会话所有API中。设置全局Header：压测时，该Header将自动...
Header
对API Header的定义，可以通过以下三种方式，使定义在不同范围内生效：设置单个API Header：该Header仅对当前API生效。设置串联链路Header：压测时，该Header将自动添加到当前串联链路所有API中。设置全局Header：压测时，该Header将自动...
API
} 返回值：boolean，true表示是运行时（搭建的应用在实际运行），false表示是设计时（平台用户正在搭建应用，组件渲染是为了预览效果）。getTopNavItems 获取一级导航菜单。定义：interface ComponentApi getTopNavItems:()=>NavItem[];} ...
读取联邦表
本文介绍了读取已保存的联邦表的 API 及示例。注意 本文涉及 API 中所有的占位符，例如"$df0"，必须包含单引号或...示例 from fascia.biz.api.dataframe import read_fed_table df=read_fed_table('$df0')返回值定义 返回的内容为联邦表对象。
自定义服务API
选中页面右侧的 选择全部参数 复选框，API的返回参数会包括所有已定义的表字段。说明 用于排序是指对查询获取的数据根据该字段的值进行排序（升序或降序），排序后再返回查询结果。在返回参数里，一个指标仅能被配置成一个参数。排序方式 ...
- 产品推荐
- 这些文档可能帮助您