客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
如何有效防止API的重放攻击？
API重放攻击（Replay Attacks）又称重播攻击、回放攻击，这种攻击会不断恶意或欺诈性地重复一个有效的API请求。攻击者利用网络监听或者其他方式盗取API请求，进行一定的处理后，再把它重新发给认证服务器，是黑客常用的攻击方式之一。HTTPS...
API网关-微服务集成服务关联角色
应用场景 创建EDAS类型的后端服务/批量导入EDAS类型的后端服务/批量导入EDAS类型的API时，API网关会提示用户创建服务关联角色，用户通过后系统会自动创建一个名称为AliyunServiceRoleForApiGatewayIntegrateWithMicroservices的服务关联...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本...如果用户需要指定授权给某些应用的API调用请求进入灰度环境，可以利用系统参数 CaAppId 来配置路由条件，配置如下-routes:name:appGrey condition:"$CaAppId=4534463 or$CaAppId=86734572"backend:type:...
后端服务调不通
如果使用的是内网 IP，请保证您的后端服务与您的 API 处于同一地域。检查您API定义的“后端超时”时间。在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以...
应用场景
异构系统集成场景 统一集成 降低企业内部系统集成的成本，无缝连接不同的软件应用程序。遗留系统兼容 允许 IT 团队选择最适合技术栈，在转型过程中并且可以兼容遗留系统，加速企业转型升级。集中管理 IT 团队可以从更集中的位置访问所有...
API 属性说明
OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源。支持英文字母、数字、英文句号（.），200 字符以内。需按照 com.xxx.opt1 的格式输入。请求路径 是 表示请求的资源的 URL，通过请求路径可以定位到要请求...
支持HTTP2.0
从而避免不必要的延迟，提升效率，在请求量比较大的场景，客户端...如何开启HTTP 2.0？ HTTPS的API都可以使用HTTP2协议进行客户端和API网关的通信。（由于 HTTP 2.0 只许在HTTPS下运行，所以需要您 使用HTTPS并用域名访问 方可启用 HTTP 2.0）
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
SetAppsAuthToApiProduct-批量授权多个APP给指定API...
批量授权多个APP给指定的API产品 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
如何获取错误信息
所有的 API 请求只要到达了网关，网关就会返回请求结果信息。用户需要查看返回结果的头部，即 Header 部分。其中 X-Ca开头的均为网关返回，比较重要信息是：/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头...
VPC授权连通性测试
VPC授权连通性测试用于验证API网关实例到您授权的VPC中实例的网络连通性，有助于将API调试阶段由于网络连通问题引发的调用失败提前暴露。本文将重点介绍VPC授权连通性测试功能，以及如何根据排错引导解决连通性测试失败的情况。...
API 管理
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
跨域资源访问（CORS）
因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览器在发送options请求时，不会带上X-Ca-Stage参数，会导致请求不到指定环境的API，插件也就无法生效了。如果API发布的是测试环境，可以...
RemoveVpcAccessAndAbolishApis-删除VPC授权
删除VPC授权并下线关联的已经发布在线上的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
CreatePlugin-创建API网关插件
接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量，不同类型，上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。调试 您可以在OpenAPI ...
API名称是什么
名称是 API 的标识，一个有意义的名称，可以让您的用户能够快速理解 API 的功能。
CreateTrafficControl-创建流控策略
接口说明 此功能面向开放 API 的用户 策略创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API分组的归属实例迁移
2 迁移步骤 您可以在控制台的左侧栏的 API管理 —— 分组管理 —— 分组详情页 中找到变更分组实例链接，单击变更分组实例，选择 目标实例，务必仔细阅读注意事项，之后单击 确认迁移 完成分组迁移，分组迁移会实时生效在API网关二级域名的...
授权信息
API：是指操作对应的API接口。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。资源类型：是指操作中支持授权的资源类型。具体说明如下：对于必选的资源类型，用背景高亮的方式表示。对于不支持资源...
数据加密
说明 目前仅支持对 HTTP 类型的 API 调用进行数据加密。使用流程 根据加密算法，生成密钥。网关管控平台创建应用并开启加密能力。客户端编码配置密钥（当前仅支持 Java 语言）。发起调用进行验证。前提条件 安装 OpenSSL 1.1.1 或更新版本...
专享实例
最长不超过三个小时 扣费方式：账单生成后会自动从您的账户余额中扣除费用以结算账单 计费示例 示例1：在华东1（杭州）创建了一个api.s1.small的专享实例（按量付费），后端服务类型为VPC，网关上发布的API由互联网上的客户端进行调用。...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
返回值为空
用户发起的 API 请求只要能够到达网关，就会返回成功/错误的结果信息。重要的返回信息都在Header里面，以X-Ca开头的为网关返回的信息。其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，...
参数访问控制插件
2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
结构体说明
AppInfoVO 名称 类型 是否必填 示例 描述 api_count NUMBER 否 1 API 数量 app_id STRING 否 app_id APPID app_name STRING 否 app_name 应用名称 app_secret STRING 否 app_secret1 appSecret app_type STRING 否 STANDARD/MPAAS 应用类型...
开通实例API概览
开通数据库审计实例的OpenAPI是基于阿里云交易和账单管理OpenAPI（BSS OpenAPI）中实例域相关的API实现的。本文介绍开通数据库审计实例的相关API。如需查看BSS OpenAPI的详细介绍，请参见 阿里云交易和账单管理API参考。调用开通数据库审计...
ModifyTrafficControl-修改用户自定义的流控策略设置
接口说明 此功能面向开放 API 的用户 修改将对策略下绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
实例类型与选择指南
1.API网关实例类型 API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡、服务器、存储等，API分组必须挂载在合法的实例下才能运行，目前API网关有如下的实例类型供您选择：1.1.实例类型说明 共享实例...
API监控的维度
可以对 API 的调用量、错误分布、响应时间、流量大小等维度进行监控。
AuthorizedApi
AuthorizedApis 描述"class="reference-link">描述 应用和API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...
API类型是什么
API 的类型包含公开、私有两种，公测期间，两种类型无特殊区别。
SetSignatureApis-绑定签名密钥与API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
DomainItem
描述"class="reference-link">描述 API的调用域名信息 节点名"class="reference-link">节点名 DomainItem 子节点"class="reference-link">子节点 名称 类型 描述 DomainName String API的调用域名
数据服务
加工后的数据供应用读取：通过数据工具对数据进行加工汇总后，业务应用希望读取这部分加工后的数据进行业务处理，则可通过API的方式快速输出。当需要变更读取的逻辑时，只需要调整API背后的数据逻辑，而不需要重新发布应用。目前API网关...
- 产品推荐
- 这些文档可能帮助您