导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
统计指标说明
API成功率 API成功率=接口调用成功的样本量/总样本量 统计API成功率的样本除了自动上报的AJAX请求，还包括手动调用 前端接口说明 上报的数据。日志字段 下列表格说明了日志中的字段含义。表 4.通用字段 字段 含义 uid 用户ID，用于标识访问...
通过云控制API实现资源管理
为什么要用云控制API管理云资源 随着云计算服务业务越来越丰富，很多云厂商为客户提供的相关的API数量也多达上万个。而在云服务被集成过程中，客户/伙伴面对上万单点API往往无从下手。从“找到正确API”到“了解使用方式”再到“弄清楚上...
IP访问控制插件
IP访问控制插件 是 API网关 提供的 API 安全防护组件之一，负责控制 API 的调用来源 IP（支持IP段）。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式：白名单：支持配置 IP 或者...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
更新VPC授权会异步更新关联的发布中的API，该API用来查询这些API的更新进度。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段的取值范围等。同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
RemoveApiProductsAuthorities-批量移除API产品对指定...
批量移除API产品对指定APP的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
SetApiProductsAuthorities-批量授权API产品给指定APP
批量授权API产品给指定APP 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
使用访问凭证访问阿里云OpenAPI最佳实践
ECS实例角色扮演 如果您的应用程序部署在阿里云ECS实例上，则可以通过ECS实例RAM（Resource Access Management）角色让ECS实例扮演具有某些权限的角色，访问阿里云OpenAPI。配置系统环境变量 对于不适用以上方案的场景，建议您使用配置系统...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
函数计算
API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。1 功能简介 API网关目前支持两种形式的函数，HTTP函数 和 事件函数。2 HTTP函数对接API网关 2.1 创建HTTP函数 在配置API...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
RemoveIpControlApis-解除API与IP访问控制的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
API网关-微服务集成服务关联角色
本文为您介绍API网关-集成微服务（ApiGateway-IntegrateWithMicroservices）的服务关联角色，ApiGateway-IntegrateWithMicroservices使用此角色来访问您在其他云产品中的资源。背景信息 API网关-微服务集成服务关联角色（ApiGateway-...
API 版本管理
API 只有在发布后才能被订阅方使用。创建后的 API 可以根据业务需求进行编辑、下线和编辑重发布等操作。新版本发布上线后，老版本自动成为历史版本被下线。API 版本的生命周期如下：版本说明：每次发布一个版本时，系统为当前版本分配一个...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
API网关-事件总线服务关联角色
本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
API名称是什么
名称是 API 的标识，一个有意义的名称，可以让您的用户能够快速理解 API 的功能。
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
DescribeImportOASTask-查询OAS导入API的任务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
AttachPlugin-绑定插件到API上
接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
功能概览
API网关支持以下功能。API 生命周期管理 覆盖设计、开发、测试、发布、运维监测、安全管控、下线等API各个生命周期阶段，API网关为每个阶段提供生产力工具；协议处理 支持HTTPS、SSL卸载、支持HTTP2.0；支持通过泛域名调用API；请求转发 ...
专享实例
实例规格使用费用 目前API网关提供了8种实例规格，每个实例规格的性能参数如下表所示：实例规格 最大入访每秒请求数（RPS）最大入访连接数 最大入访每秒新建连接数（CPS）最大出访连接池大小 最大公网入访带宽（bps）最大公网出访带宽（bps...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
- 产品推荐
- 这些文档可能帮助您