名词解释
API定义 API服务方创建API时，设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则...
WAF接入配置
本文主要介绍如何配置WAF，对API网关上发布的API进行增强安全防护。1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP ...
使用限制
每个账号下，每个Region默认最多创建5个未绑定域名的API分组，如果在此Region中有绑定域名的API分组，则未绑定域名的API分组总数上限为20个；支持通过 提交工单 申请增加API分组数量限制。公网二级域名限制 直接使用API分组的公网二级域名...
查看及管理API版本
操作 您可以对API和工作流程进行查看和回滚操作：单击相应API或工作流程后的 API详情，进入API或工作流程详情页面进行查看。单击相应API或工作流程后的 回滚，在 确定要回滚当前版本 对话框中，单击 确认。您还可以在 版本 对话框中，选中...
DDoS防护接入配置
什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称DDoS）将多台计算机联合起来作为攻击平台，通过远程连接，利用恶意程序对一个或多个目标发起DDoS攻击，消耗目标服务器性能或网络带宽，从而造成服务器无法正常地提供服务。...
管理授权对象
绑定的 API 在授权应用详情页的 绑定的 API 标签页中，可查看当前授权应用已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
管理 CORS 规则
绑定的 API 在 CORS 规则详情页的 绑定的 API 页签中，可查看当前 CORS 规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量...
管理路由规则
绑定的 API 在路由规则详情页的 绑定的 API 标签页中，可查看当前路由规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
机器人使用说明
可以在控制台我的应用-我的申请列表查看申请的应用状态。如图所示：2).选择企业应用-应用申请审批（账号需具备企业应用权限），可以看到用户的申请，点击通过。3).申请通过后，在机器人中可以看到申请通过后的应用。2.执行应用 执行应用的...
AttachApiProduct-将API绑定到指定API产品
将API绑定到指定的API产品（如果指定的API产品不存在，将自动创建）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出...
使用SDK调用API
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...
产品简介
通过API网关强大的适配和集成能力，可以将各种业务系统的API实现统一管理和统一调用：支持异构网络环境：无论您的业务系统部署在阿里云、本地数据中心、或其他云，API网关均可以统一管理；支持对接多种系统实现方式：您的业务系统基于ECS、...
应用场景
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
TCP连接超时时间配置
具体配置 上文说到的ClientReadTimeout需要在客户端的初始化HttpClient连接池的代码中配置，拿API网关提供的SDK举例，在下面代码中配置：上文说到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：
批量操作API
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
CreateFlow-创建一个流程
接口说明 每个用户所能创建的流程个数受资源限制（详见 使用限制），如果您有特殊需求，可以提工单进行调整。流程在用户级别是按照名称来区分的，即单一账号下不可以存在同名流程。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您...
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
发布API商品
1 概述 阅读对象：云市场合作伙伴，希望将自己的API上架到云市场上进行售卖。在完成服务商入驻API集市后，API商品上架过程分成两个步骤：步骤一：在API网关上进行API的配置，并发布在API网关上；步骤二：在云市场服务商控制台上进行API商品...
DetachApiProduct-解除API与API产品的绑定关系
解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
API网关-监控服务关联角色
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
事件总线
本文将快速引导您如何在API网关中，发布后端服务为事件总线类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您...
常见问题
本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取？CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦，可前往 在线调试API门户 查看对应的requestPath。
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
ApiGateway服务关联角色
本文为您介绍ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）的应用场景以及如何删除服务关联角色。背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问...
对象存储
本文将快速引导您如何在API网关中，发布后端服务为对象存储（OSS）类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API...
查看及管理API
版本管理：若下游应用调用API的API_ID无法修改，在API的数据源或查询条件发生变更后，可通过多版本的方式开发、测试后，再将新版本发布至生产环境中以覆盖原来的版本，避免下游应用端的调整。配置详情请参见 API多版本管理。转让负责人：可...
DescribeDeployedApis-查询已发布 API 列表
查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
API调试及自助排错
2.调试信息获取错误信息 所有的API请求只要到达网关，网关就会返回请求结果信息。用户可以查看返回结果的头部，即Header部分，来获取API网关返回的信息。其中X-Ca开头的属性均为API网关返回，其中您需要重点关注的信息为：X-Ca-Error-Code...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
导出标准OAS定义
API发布与扩展：通过将使用标准OAS规范的API定义转化为API网关的API资源，您能够快速在API网关创建和配置API，然后根据您的需求，自定义和扩展API的功能和行为。通过API网关的灵活性，您可以更好地管理和控制API的访问权限、流量限制和请求...
queryMyAppApplys
调用地址：console-rpa.aliyun.com/rpa/openapi/app/queryMyAppApplys调用方式：GET 返回类型：JSON 接口说明：查询我的申请列表 请求参数 名称 类型 是否必选 示例值 描述 progress String 否 pass 应用申请状态 currentPage Integer 否 1...
- 产品推荐
- 这些文档可能帮助您