SDK和API概览
通用文档智能 关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API使用指南。行业文档智能 关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API概览。
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
查看API详情
前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式创建三方API 使用批量方式创建三方API 创建数据上报API 创建空间服务API 操作步骤 登录 数据资源平台控制台。...
添加API标签
前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式创建三方API 使用批量方式创建三方API 创建数据上报API 操作步骤 登录 数据资源平台控制台。在页面左上角，单击 ...
测试API
前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式创建三方API 使用批量方式创建三方API 创建数据上报API 操作步骤 登录 数据资源平台控制台。在页面左上角，单击 ...
上线API
前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式创建三方API 使用批量方式创建三方API 创建数据上报API 创建空间服务API 操作步骤 登录 数据资源平台控制台。...
SetApisAuthorities-给多个API添加APP访问权限
接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
概述
具体操作过程请参考 使用简单认证（AppCode）方式调用API 使用摘要签名认证方式调用API 相比简单身份认证，摘要签名方式安全性较高，适合于较多场景。客户端在调用API时，需要先根据事前分配好的APP Key和APP Secret对请求内容计算签名，在...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
API分组同步
若源分组API使用了模型，目标分组不存在同名模型，则模型自动同步到目标分组；若目标分组API存在源分组API引用的同名模型，源分组该模型的具体定义不会同步到目标分组；分组定义的环境变量不会同步到目标分组；要向一个新的API分组进行同步...
参数访问控制插件
2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...
开放API（OpenAPI）
DataWorks开放平台提供OpenAPI能力，通过调用DataWorks的OpenAPI使用DataWorks的各项功能，实现应用和DataWorks的集成和交互。背景信息 DataWorks的OpenAPI提供100多个API功能，通过调用API，可以快速进行批量操作和系统集成对接等工作，...
使用后端服务提高管理效率
现在有多个API使用了后端服务testHttp，并且发布在了测试环境，单击右上角修改进入修改界面，现在修改后端地址并进行发布，会提示您当前环境有已经发布的API，修改后关联的API会批量更新后端地址，确定之后可以在列表中看到发布的API的发布...
创建后端为函数计算的API
步骤7 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 保存 按钮。步骤8 发布API 在上一环节保存成功后，会提示...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
事件总线
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击 保存 按钮。发布API 对API进行过任何的配置，都需要发布到对应的环境中才能够生效。...
API通道SDK
设置API接口的版本号，本示例为1.0.2.authType("iotAuth")/当云端接口需要用户身份鉴权时需要设置该参数，反之则不需要设置.addParam("input","测试")/参照API文档，设置API接口的参数，也可以使用.setParams(Map,Object>params)来设置....
创建后端服务为VPC内资源的API
步骤7 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 创建 按钮。步骤8 发布API 在上一环节保存成功后，会提示...
对象存储
步骤8 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。步骤9 发布API 您对API进行过任何的配置，都需要...
创建后端服务为HTTP的API
步骤6 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 创建 按钮。步骤7 发布API 在上一环节保存成功后，会提示...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
DescribeAuthorizedApis-查询已授权的API列表
接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权...
申请使用API
单击 待审批 页签，找到“根据银行客户办卡额度查询”API使用申请单，并单击 查看，进入申请单详情页面。单击 通过，在弹出的对话框中输入审批意见为“同意”，单击 确认。预期结果 登录租户一般用户，单击 图标，选择 研发工作台>>API管理...
创建 API
CaHttpSchema 用户调用API使用的协议，http或者https CaProxy 代理（AliCloudApiGateway）CaClientUa 请求客户端的User-Agent CaCloudMarketInstanceld 请求的云市场商品的实例ID CaAppKey 请求的APP的KEY CaStage 请求的环境（RELEASE、...
函数计算内网访问API网关
步骤2：配置后端服务类型为VPC的API 此步骤的详细过程可参见 使用VPC内资源作为API的后端服务，配置要点如下：创建VPC授权，创建成功后如下图所示：创建后端服务为VPC的API，为了方便后续的调用测试，API使用无认证方式，如下图所示：API...
API概览
ImportOAS 通过OAS导入API 使用标准OAS定义导入API。ImportSwagger 通过 Swagger 创建 API 通过导入符合阿里云 Swagger 规范的文本内容创建 API。DeleteApi 删除 API 定义 删除指定的API定义。DeleteApiStageVariable 删除环境的指定变量 ...
Zookeeper
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。发布API 在上一环节保存成功后，需要发布API。对API进行过任何的配置，都...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
数据服务
使用场景包括：最小粒度的数据输出：当企业需要对外提供数据时，相较于直接对外提供表数据，使用API的方式可以控制到行级（SQL过滤条件）和列级（查询字段），这样能帮助用户只对外暴露最小单元的数据，保障数据安全。可视化制作：对于多数...
Nacos
定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。发布API 在上一环节保存成功后，需要发布API。您对API进行过任何的配置，...
使用限制
本文描述了API网关的使用限制。限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多...
使用OpenAPI
本文为您介绍使用API网关OpenAPI的基本信息及注意事项。说明 关于如何使用阿里云OpenAPI，请参见学习文档：使用OpenAPI。基本信息 版本说明 版本号 说明 2016-07-14 推荐 接入点说明 参见 服务接入点。用户身份 用户身份 支持情况 阿里云...
功能简介
已获授权API 对已获授权API通过API维护和应用维度进行查看，支持测试API、下载API使用文档、下载密钥SDK和归还权限，也支持查看单个API的授权详情，包括：授权人、授权时间、访问路径、AppKey和AppSecret等。已对外授权API 支持查看通过...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
API结果过滤器
traceId 本次调用追踪的唯一ID message 当code为ERROR会在message里返回错误原因 若API使用者希望去掉code、traceId等字段的封装只返回其中data的部分。当正确配置过滤器后，返回结构如下：可以看到返回结果中只剩下了data字段里的内容，...
- 产品推荐
- 这些文档可能帮助您