使用后端服务提高管理效率
现在有多个API使用了后端服务testHttp，并且发布在了测试环境，单击右上角修改进入修改界面，现在修改后端地址并进行发布，会提示您当前环境有已经发布的API，修改后关联的API会批量更新后端地址，确定之后可以在列表中看到发布的API的发布...
创建后端为函数计算的API
步骤7 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 保存 按钮。步骤8 发布API 在上一环节保存成功后，会提示...
事件总线
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击 保存 按钮。发布API 对API进行过任何的配置，都需要发布到对应的环境中才能够生效。...
创建后端服务为VPC内资源的API
步骤7 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 创建 按钮。步骤8 发布API 在上一环节保存成功后，会提示...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
创建后端服务为HTTP的API
步骤6 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 创建 按钮。步骤7 发布API 在上一环节保存成功后，会提示...
对象存储
步骤8 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。步骤9 发布API 您对API进行过任何的配置，都需要...
API结果过滤器
traceId 本次调用追踪的唯一ID message 当code为ERROR会在message里返回错误原因 若API使用者希望去掉code、traceId等字段的封装只返回其中data的部分。当正确配置过滤器后，返回结构如下：可以看到返回结果中只剩下了data字段里的内容，...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
函数计算内网访问API网关
步骤2：配置后端服务类型为VPC的API 此步骤的详细过程可参见 使用VPC内资源作为API的后端服务，配置要点如下：创建VPC授权，创建成功后如下图所示：创建后端服务为VPC的API，为了方便后续的调用测试，API使用无认证方式，如下图所示：API...
创建 API
CaHttpSchema 用户调用API使用的协议，http或者https CaProxy 代理（AliCloudApiGateway）CaClientUa 请求客户端的User-Agent CaCloudMarketInstanceld 请求的云市场商品的实例ID CaAppKey 请求的APP的KEY CaStage 请求的环境（RELEASE、...
Zookeeper
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。发布API 在上一环节保存成功后，需要发布API。对API进行过任何的配置，都...
数据服务
使用场景包括：最小粒度的数据输出：当企业需要对外提供数据时，相较于直接对外提供表数据，使用API的方式可以控制到行级（SQL过滤条件）和列级（查询字段），这样能帮助用户只对外暴露最小单元的数据，保障数据安全。可视化制作：对于多数...
Nacos
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。发布API 在上一环节保存成功后，需要发布API。您对API进行过任何的配置，...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
API概览
ImportOAS 通过OAS导入API 使用标准OAS定义导入API。ImportSwagger 通过 Swagger 创建 API 通过导入符合阿里云 Swagger 规范的文本内容创建 API。DeleteApi 删除 API 定义 删除指定的API定义。DeleteApiStageVariable 删除环境的指定变量 ...
使用限制
本文描述了API网关的使用限制。限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多...
使用OpenAPI
本文为您介绍使用API网关OpenAPI的基本信息及注意事项。说明 关于如何使用阿里云OpenAPI，请参见学习文档：使用OpenAPI。基本信息 版本说明 版本号 说明 2016-07-14 推荐 接入点说明 参见 服务接入点。用户身份 用户身份 支持情况 阿里云...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
环境管理
目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的测试环境资源，从而可以保证在同一套API配置的情况下，供您的测试人员进行测试使用。在API网关上进行环境管理的时候，您需要做两部分工作：API的后...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
TCP连接超时时间配置
本文档站在API网关的角度对API网关的客户端和后端服务做出TCP连接超时时间配置的建议，以便用户更好地使用API网关，避免遇到一些已知的问题。关于基于HTTP协议的TCP超时时间，常见的有以下几个配置：连接建立超时时间（ConnectionTimeout）...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求...
通过云控制API实现资源管理
为什么要用云控制API管理云资源 随着云计算服务业务越来越丰富，很多云厂商为客户提供的相关的API数量也多达上万个。而在云服务被集成过程中，客户/伙伴面对上万单点API往往无从下手。从“找到正确API”到“了解使用方式”再到“弄清楚上...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
ServiceConfig
后端服务超时时间，单位：毫秒 ContentTypeCatagory String 否 调用后端服务HTTP服务时，ContentType头的取值策略：DEFAULT：使用API网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的ContentType的头 ContentTypeValue String 否 ...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
API网关灰度发布最佳实践
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
搭建无服务器应用之手机号归属地查询
本文主要介绍配合使用API网关、函数计算和云市场三种产品，搭建一个可以查询手机号归属地的服务。在这个框架里不需要配置Web容器、不需要搭建运行环境、不需要购买负载均衡，通过配置和一段代码即可完成一个高扩容无服务器的应用服务。服务...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您