基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
超时控制
boltBindingParam.setTimeout(2000)非 Spring 环境下 API 方式 如果在非 Spring 环境下直接使用 SOFARPC 的裸 API 引用服务，设置 ConsumerConfig 的 timeout 属性即可。ConsumerConfig<SampleService>consumerConfig=new ConsumerConfig()...
Bolt 协议的调用方式
Spring 环境 API 方式 如果在 Spring 或者 Spring Boot 的环境下使用 API 的方式，设置 BoltBindingParam 的 type 属性为 callback，并且设置 callbackClass 或者 callbackRef 属性即可。以 callbackClass 为例，代码如下：...
API 概览
流水线控制 API 名称 描述 运行流水线 运行流水线 终止运行流水线 可以取消运行流水线 删除流水线成员 可以删除流水线成员 更新流水线成员 可以更新流水线成员 增加流水线成员 可以增加流水线成员 使用流水线模板创建流水线 使用流水线模板...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些...注意：API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作。
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
使用Redis在Web应用中实现会话管理
Spring Session可以用透明的方式集成HttpSession，从而实现Web应用中的会话管理，该方案有以下优势：支持 集群会话（Clustered Sessions）Spring Session使支持集群会话变得很简单，不必依赖于应用程序容器（例如Tomcat等）提供的特定解决...
产品对比
修改过的配置自动推送到监听的客户端 修改过的配置自动推送到监听的客户端 API接口 基于 RESTful API，同时支持 Java Native 接口，Spring Cloud 接口，和其他语言类接口 基于 RESTful API 和 Spring Cloud 规范，同时也支持其他语言客户端...
DescribePurchasedApis-获取购买的 API 列表
PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
CreateApi-创建 API
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
调用重试
非 Spring 环境下 API 方式 如果是在非 Spring 环境下直接使用 SOFARPC 的裸 API 的方式，可以通过调用 ConsumerConfig 的 setRetries 方法来设置重试次数：ConsumerConfig<RetriesService>consumerConfig=new ConsumerConfig();...
负载均衡
非 Spring 环境下 API 方式 如果在非 Spring 环境下直接使用 SOFARPC 提供的裸 API，可以通过调用 ConsumerConfig 的 setLoadBalancer 方法来设置。以下示例以设置负载均衡算法为 random 为例：ConsumerConfig consumerConfig=new ...
Bolt 协议的基本用法
Service@SofaService(bindings={@SofaServiceBinding(bindingType="bolt")})public class SampleServiceImpl implements SampleService{ } Spring 环境下 API 方式 在 Spring 或者 Spring Boot 环境下发布一个 Bolt 协议的服务只需往 ...
自定义线程池
SofaService(bindings={@SofaServiceBinding(bindingType="bolt",userThreadPool="customThreadPool")})public class SampleServiceImpl implements SampleService{ } 在 Spring 环境使用 API 方式 如果是在 Spring 环境下使用 API 的方式...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
创建服务项目
绑定应用或者被组合API引用时，拦截不允许发布：API绑定应用或者被组合API引用时，不允许新版本发布到线上，保证下游应用和组合API的正常调用。适用于使用范围广，影响面大的重要API，如果变更发布到线上会严重影响下游时可以拦截。被组合...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
创建后端为函数计算的API
API返回内容为前面步骤中创建的函数返回内容，函数代码如下：7 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...
MPC API
整体过程分为 6 步：服务端开发 注册 API 分组 创建 API 配置 API 服务 测试 API 服务 生成客户端 SDK 服务端开发 引入网关二方包 在项目的主 pom.xml 文件中引入如下二方包（如原工程已经有依赖，请忽略）。其中 mobilegw-unify 系列依赖...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
产品优势
统一易用的编程接口 每一个 SOFA 中间件都是独立可插拔的组件，对集成的 SOFA 中间件提供统一易用的编程接口，节约开发时间，和后期维护的成本。遵循 OpenTracing 埋点 提供平台无关、厂商无关的 API，使得开发人员能够方便的添加（或更换...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
目前 ACM 的客户端支持哪些语言？
目前支持 ACM Java Native SDK，Spring Cloud ACM,Node.js三种。...ACM Java Native SDK：ACM 原生的 Java SDK...Spring Cloud ACM：ACM 基于 Spring Cloud Config 的 API 实现。ACM Node.js SDK：支持 ACM 配置监听和变更的 Node.js 原生 SDK。
微服务治理支持的Java框架
支持的框架 流量防护和指标监控 分类 框架名称 框架版本 Web Spring MVC 对应Spring Cloud关联版本 Spring Boot 2.x.x Spring Cloud F、G、H、2020.x、2021.x Feign 对应Spring Cloud关联版本 Java网关 Spring Cloud Zuul 1.3.x Spring ...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
上传API至API网关
使用Cloud Toolkit可以解析Spring项目，将Controller/RestController中的接口自动解析为API上传至API网关。您无需手动录入API，便可快速完成API网关的接口信息录入。本文介绍如何将API上传至API网关。前提条件 已在IntelliJ IDEA中安装和...
上传API至API网关
使用Cloud Toolkit可以解析Spring项目，将Controller/RestController中的接口自动解析为API上传至API网关。您无需手动录入API，便可快速完成API网关的接口信息录入。本文介绍如何将API上传至API网关。前提条件 已在IntelliJ IDEA中安装和...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
- 产品推荐
- 这些文档可能帮助您