调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要...
请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 GroupId string 是 API ...
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 ...
接口说明 此功能面向开放 API 的用户 用于查询某 Region 下的后端签名密钥列表，Region 为系统参数 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 ...
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 ...
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建路由规则 sofa.apigateway.router.create 用于快速创建一个路由规则。请求参数 名称 类型 是否必填 示例 描述 param RouterInfoVO 是-param tenant_id STRING 是 ...
本文列出了授权应用相关的 API 及其请求参数、返回参数。创建授权应用 sofa.apigateway.authapp.create 用于创建一个授权应用。请求参数 名称 类型 是否必填 示例 描述 param AuthAppInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户...
Json Web Token(RFC7519),是一种便捷的可用于网关进行请求认证的鉴权方案，API 网关 可以通过托管用户的 Public JWK 实现对请求进行JWT认证，并将 claims 作为后端参数转发给后端，以方便用户简化开发后端应用的开发。本文主要是JWT认证...
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
描述 列举API上IP访问控制信息项的类型 节点名 ApiIpControlItem 子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间
接口说明 此功能面向开放 API 的用户 此功能效果仅是创建密钥策略，需要再调用绑定接口才能绑定到 API 上 此密钥绑定到 API 后，网关到您后端服务的请求会带有签名字符串，您的后端服务可以自定义是否验证该签名字符串 该接口调用的 QPS ...
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些...注意：API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作。
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
secret 为绑定到 API 上的签名密钥 hmacSha256.init(new SecretKeySpec(keyBytes,0,keyBytes.length,"HmacSHA256"));String sign=new String(Base64.encodeBase64(Sha256.doFinal(stringToSign.getBytes("UTF-8")),"UTF-8"));抽象一下就是...
2.4 精准状态控制 为了保证高可用性和高性能，API网关采用集群模式将应用服务部署在多个节点上，属于分布式架构。默认情况下，不同的服务节点会独立计算并保存断路器的状态，因此从全局角度来看，断路器可能出现状态不准确的情况。如果您对...
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。创建应用 sofa.apigateway.app.create 用于创建一个应用。请求参数 名称 类型 是否必填 示例 描述 param AppInfoVO 是 param tenant_id STRING 是 TSCPDICNT 租户标识 ...
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
1 ApiInfoList array object 返回的 API 列表信息 ApiInfo object ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api ...
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
更新VPC授权会异步更新关联的发布中的API，该API用来查询这些API的更新进度。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...
您在API市场上购买API之后，即完成API的自动授权。您可以在管理控制台寻找您都已经购买的API。打开 云市场，在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")...
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
变更历史 变更时间 变更内容概要 操作 2024-07-08 OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 查看变更详情 2023-09-11 OpenAPI 错误码发生变更 查看变更详情 2023-05-17 ...
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
本文介绍如何查看已获授权API。前提条件 申请使用API成功，具体操作，请参见 申请使用API。使用租户一般用户登录。...单击API名称 根据银行客户办卡额度查询，可查看API详情，包括基本信息、应用请求、响应示例和用户评价等。
实例规格使用费用 目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示：实例规格 最大入访每秒请求数（RPS）最大入访连接数 最大入访每秒新建连接数（CPS）最大出访连接池大小 最大公网入访带宽（bps）最大公网出访带宽（bps...
删除VPC授权并下线关联的已经发布在线上的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
删除后端服务在某个环境上的定义，删除后，使用该后端服务并发布在此环境上的API都会下线。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
前提条件 已 购买DDoS高防实例 在API网关上已经发布了API 配置步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。重要 由于后续步骤中还需接入DDoS防护，建议当前阶段绑定域名时使用TXT解析。步骤2：参考 防护...
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...