产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
同步 API
同步 API 可将当前环境中的 API 同步至其他环境中。为保证系统稳定性，只同步目标环境不存在的 API 配置。同步后，会自动加载配置使其生效。操作步骤 登录 mPaaS 控制台，在左侧导航栏，点击 移动网关 菜单。在 API 管理 标签页中，点击 更...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
RestartInstance-重启集群
说明 当该参数为空或填写早于当前时间时，集群将立即进行重启。2023-03-22T00:00:50Z 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID。F5178C10-1407-4987-9133-DE4DC9119F75 示例 正常返回示例 JSON 格式 {"RequestId":...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
GetResourcePackagePrice-资源包产品询价服务
订单类型为 购买时，不支持询价 生效时间大于当前时间六个月的资源包。订单类型为 升级时，生效时间 必须小于等于升级的资源包实际到期时间。日期格式按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：yyyy-MM-ddTHH:mm:ssZ。2020-02-...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
DescribeSavingsPlansUsageDetail-节省计划使用率明细
节省计划使用率明细查询 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中...
获取服务调用量
Web前端直接调用 小程序场景下直接调用 Android端直接调用 iOS端直接调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 ...
OpenAPI错误代码表
OpenAPI 2.0-推送高级接口时，PushTime和ExpireTime 参数，需注意时间格式应按照ISO8601标准表示，并使用UTC时间，格式为 YYYY-MM-DDThh:mm:ssZ，过期时间不能小于当前时间或者定时发送时间加上3秒（ExpireTime>PushTime+3秒），3秒是为了...
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。...批量解绑：若需要一次解绑当前规则下的多个 API，可先通过左侧的复选框勾选多个 API 后，单击页面底部的 批量解除授权，在弹出的确认框中单击 确定，即可批量解除 API 的绑定。
版本说明
变更时间：2023-05-23 变更集发布说明：OpenAPI 名称 变更内容概要 操作 ListAppSessions OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2023-05-23 变更集发布说明：...
DescribeResourceUsageDetail-资源使用率明细
为空表示截止到当前时间 2021-01-02 00:00:00 PeriodType string 是 MONTH：月维度；DAY：天维度；HOUR：小时维度；HOUR NextToken string 否 分页 token，首页查询时传空，查询结果中返回下一页 token 地址。当结果 token 为空时表示全部...
版本说明
变更时间：2023-12-21 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetPipelineRun OpenAPI 入参发生变更。查看API变更历史 查看API文档 变更项 变更内容 入参 OpenAPI 入参发生变更。新增入参：TokenId GetPipelineRunNode OpenAPI ...
获取服务调用QPS情况
Web前端直接调用 小程序场景下直接调用 Android端直接调用 iOS端直接调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 ...
绑定/解绑 API
授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。...批量解绑：若需要一次解绑当前授权应用下的多个 API，可先勾选多个 API 后，单击页面底部的 批量解除绑定，在弹出的确认框中单击 确定，即可批量解除绑定多个 API。
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
DescribeResourceCoverageDetail-资源覆盖率明细
为空表示截止到当前时间 2021-01-02 00:00:00 PeriodType string 是 MONTH：月维度；DAY：天维度；HOUR：小时维度；HOUR NextToken string 否 分页 token，首页查询时传空，查询结果中返回下一页 token 地址。当结果 token 为空时表示全部...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
SyncQualityCheck-进行实时质检
beginTime Long 否 录音&对话的开始时间，格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒到现在的毫秒数（即毫秒时间戳，例如：1584535485856），如果每次调用都传入，以第一次调用为准，若不指定，则会取当前时间。...
AppAttribute
列举APP的信息。描述 节点名 AppAttribute 子节点 AppId Long APP编号 AppName String APP名称 Description String APP描述信息 CreatedTime String 创建时间（格林威治时间）ModifiedTime String 修改时间（格林威治时间）
概述
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
使用SDK调用API
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...
PluginAttribute
描述 插件详情 节点名 PluginAttribute 子节点 名称 类型 描述 PluginId String 插件ID PluginType String 插件类型 PluginName String 插件...CreatedTime String 创建时间，格林威治时间 ModifiedTime String 最后修改时间，格林威治时间
CatalogAttribute
描述 节点名 CatalogAttribute 子节点 RegionId String 所在的region CatalogId String 目录编号 CatalogName String 目录名称 Description String 描述 ParentId String 父目录编号 CreatedTime String 创建时间（格林威治时间）...
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
IpControlInfo
描述 列举IP访问控制信息项的类型 节点名 IpControlInfo 子节点 名称 类型 描述 RegionId String 所在的region IpControlId String IP访问控制编号 IpControlName String...CreateTime String 创建时间(UTC)ModifiedTime String 修改时间(UTC)
应用场景
异构系统集成场景 统一集成 降低企业内部系统集成的成本，无缝连接不同的软件应用程序。遗留系统兼容 允许 IT 团队选择最适合技术栈，在转型过程中并且可以兼容遗留系统，加速企业转型升级。集中管理 IT 团队可以从更集中的位置访问所有...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
开通IPv6
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例分配...
- 产品推荐
- 这些文档可能帮助您