简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
2023年11月之前
新增 高级版、企业版、旗舰版 2021-11-29 日志审计 主动外联 主动外联支持SSL流量分析 新增 高级版、企业版、旗舰版 2021-11-29 主动外联 VPC边界防火墙 VPC边界防火墙开放API接口。新增 企业版、旗舰版 2021-11-22 API概览 VPC边界防火墙 ...
售前常见问题
狭义的互联网暴露面是暴露在互联网的已知或未知资产，包括但不限于IP、端口、域名、应用、API接口等，企业接入网络的资产数量快速增长，互联网暴露面的风险增加，而互联网暴露面越多越大，企业面临的威胁就越大，有效管理互联网暴露面是...
DeleteApiProduct-删除API产品
删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
函数计算
API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。1 功能简介 API网关目前支持两种形式的函数，HTTP函数 和 事件函数。2 HTTP函数对接API网关 2.1 创建HTTP函数 在配置API...
API概览
本产品（云防火墙/2017-12-07）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过...
DetachApiProduct-解除API与API产品的绑定关系
解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...
RemoveIpControlApis-解除API与IP访问控制的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
RemoveSignatureApis-解除API与后端签名密钥的绑定
解除API与后端签名密钥的绑定关系。接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
SetTrafficControlApis-添加指定流控策略与API的绑定
接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
使用SDK调用API
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
HTTPS 证书报错
只在与 API 提供商无法提供兼容性更好的主流 SSL 证书，且安全风险可控的前提下，可以考虑使用此方法。2.API提供者的 SSL 证书过期 提供者的 SSL 证书过期。解决方案 联系 API 提供者，要求其更换 SSL 证书。程序中忽略检查 SSL 证书有效性...
SetSignatureApis-绑定签名密钥与API
添加指定签名密钥与API的绑定。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
SetIpControlApis-绑定IP访问控制与API关系
添加指定IP访问控制与API的绑定关系。接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
DeleteApp-删除应用
接口说明 此功能面向调用 API 的用户 注意删除之后不可恢复，与 API 的授权关系也不可恢复 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
使用 RAM 管理 API
acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
API概览
防火墙 API 标题 API概述 DeleteFirewallRules 批量删除实例防火墙规则 删除指定轻量应用服务器的多条防火墙规则。CreateFirewallRule 创建实例的防火墙规则 为指定的轻量应用服务器创建一条防火墙规则。CreateFirewallRules 批量创建实例...
基于Swagger完成API网关与用户CICD流程整合
如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义 步骤2：创建API分组 步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中 步骤4：对API进行各项额外配置 自动...
云防火墙的审计事件
云防火墙已与操作审计服务集成，您可以在操作审计中查询用户操作云防火墙产生的管控事件。操作审计支持将管控事件投递到日志服务SLS的LogStore或对象存储OSS的存储空间中，满足实时审计、问题回溯分析等需求。操作审计记录了用户通过Open...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
RAM用户权限管理最佳实践
RAM权限策略Action是 yundun-cloudfirewall:+接口名称，其中RAM自定义权限策略中的Action与该云产品的API一一对应。例如，yundun-cloudfirewall:DescribeAssetList 就表示查询云防火墙防护的资产的信息，对应的API是 DescribeAssetList-...
概述
本文主要介绍临云镜标注工具 SDK 基于全景图像的空间标注能力，包括空间结构、墙线、门、窗、虚拟墙、凹凸墙、特征区等标注行为，以及如何进行空间关联、特征关联的操作，调用OpenAPI进行重建与预览的 整体流程。标注工具SDK简介 临云镜...
CreateVpcFirewallCenConfigure-创建VPC边界防火墙
该 VPC 边界防火墙可以防护云企业网内的网络实例（网络实例包含 VPC、VBR 和 CCN）和指定 VPC 之间的互访流量，不支持防护 VBR 与 VBR、CCN 与 CCN、VBR 与 CCN 之间的互访流量。更多信息，请参见 VPC 边界防火墙限制说明。QPS 限制 本接口...
功能发布记录
告警设置 2018-07-27 OpenAPI发布 Web应用防火墙针对常见控制台配置操作开放对应API接口，方便用户执行批量化操作。API概览 2018-05-29 推出业务数据大屏试用服务 Web应用防火墙推出业务数据大屏试用，方便用户及时了解网站业务全貌。大屏...
什么是Web应用防火墙
应用防护 RASP和Web应用防火墙的关系 应用防护RASP（Runtime Application Self-Protection）是一种运行在应用程序内部的安全保护机制，它能够在应用运行时检测攻击并进行自我保护。更多详情，请参见 应用防护。RASP和Web应用防火墙并不是...
CreateVpcFirewallConfigure-创建VPC边界防火墙
接口说明 本接口一般用于创建 VPC 边界防火墙。该 VPC 边界防火墙是防护通过高速通道连接的两个 VPC 之间的流量。该 VPC 边界防火墙不支持防护 VPC 跨地域、跨账号以及 VPC 与 VBR 间的互访流量。更多信息，请参见 VPC 边界防火墙限制说明...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 ...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
计费说明
关于不同版本支持的基础服务与增值服务的费用详情，请参见 Web应用防火墙3.0（包年包月）购买页。关于重保场景防护的费用详情，请参见 重保场景防护计费说明。说明 如果您为ALB实例开启WAF防护，除了在WAF侧收取上述计费项费用外，ALB等也...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
- 产品推荐
- 这些文档可能帮助您