导出标准OAS定义

概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义,结合API网关的 导入标准OAS定义,您可以:跨平台跨地域迁移数据:借助API网关的导出和导入功能,您可以方便地从其他平台或API网关导出OAS规范的API数据,并在其他地域或账号下...

版本说明

变更时间:2024-01-25 变更集发布说明:OpenAPI 名称 变更内容概要 操作 SetRenewal API 内部配置变更,不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更,不影响调用。变更时间:2023-12-13 变更集发布说明:...

概述

具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API,具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范,被广泛应用于定义和描述后端应用服务的API。现在,API网关支持...

管理外部授权 API

在 外部授权 API 页面,您可以根据业务需要,进行以下操作:查看外部授权 API 在外部授权 API 列表页,您可以查看外部授权 API 的概览信息,包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...

绑定/解绑 API

创建 CORS 规则后,您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页,单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中,单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中,勾选需要绑定的 API...

API报警设置

4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则,进入API分组详情页,点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时,会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...

发布API商品

发布完成后,由于API的认证方式是"阿里云APP",因此需要在 应用管理 菜单中创建一个调试用的APP,如下图:需要在API的 授权信息 菜单中,为此API添加授权,授权成功后如下图所示:最后可以在 API调试 菜单中进行参数的调试确认,如下图所示...

批量操作API

注意事项 批量修改API基础配置后,可一键发布API,发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据,没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用(APP)。...

管理 API 分组

API 列表:列出了该 API 分组下所有的 API 以及 API 的概览信息,比如 API 名称,前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表,您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...

概述

了解做为API网关管理员,如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API,安全性很低,适合临时测试的场景,不建议使用。使用AppCode调用API(简单身份认证)AppCode认证方式,调用简单,但安全...

API 流量治理

本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6...

事件总线

概述 您需要依次完成以下步骤:创建后端服务 创建API分组 定义API 创建应用API授权 调试API 调用API 前提条件 您需要先开通事件总线,并创建自己的自定义事件总线,详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台,在...

概述

角色说明 API 网关产品涉及以下两个角色:API 发布者:将自身应用的服务接口API 网关上创建并发布为 API 服务以对外发布。API 订阅者:使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下:...

绑定/解绑 API

绑定 API 在 授权管理 页面,找到目标应用,单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中,单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中,勾选需要绑定的 API。单击页面底部的 确认,即可完成绑定。解绑 ...

创建后端为函数计算的API

本文将快速引导您如何在API网关中,发布后端服务为函数计算类型的API,并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤:创建函数;创建分组;定义API;创建应用API授权;调试API;调用API。2 创建函数 ...

API 分组

本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...

DescribeApiProductApis-查询API产品绑定的API列表

查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...

服务接入点

亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1(青岛)cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2(北京)...southeast-2 apigateway.ap-southeast-2.aliyuncs....

名词解释

名词 解释 应用(APP)用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对,加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息,用于网关对请求做身份验证。授权 授予某个APP调用某个API...

对象存储

创建存储空间(Bucket)阿里云对象存储OSS(Object Storage Service)是阿里云提供的海量、安全、低成本、高持久的云存储服务,OSS具有与平台无关的RESTful API接口,您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...

API概览

我们已经为开发者封装了常见编程语言的SDK,开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入...

DescribeDeployedApis-查询已发布 API 列表

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限策略语句的 ...

版本管理

1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤:1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑,单击 ...

DescribeApis-查询定义中的 API 列表

接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表,以及概况信息 请注意是返回所有编辑中的 API 定义信息,跟环境无关,也可能跟环境中正在运行的定义不同,是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...

流控信息

API名称 API版本 配额 配额维度 UpdateResource 2022-08-30 10/1(s)地域:*API限速维度:regionId,API,ParentUid GetResourceType 2022-08-30 100/1(s)地域:*API限速维度:regionId,API,ParentUid CreateResource 2022-08-30 10/1(s)地域...

获取服务端信息

为了让客户端与网关建立连接,您必须在 API 网关控制台上获取以下信息:应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中,应用在环境中的唯一标识...

ApiHisItem

描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...

AuthorizedApi

AuthorizedApis 描述"class="reference-link">描述 应用API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...

ApiSummary

ApiSummarys 描述"class="reference-link">描述 API概要信息项 节点名"class="reference-link">节点名 ApiSummary 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...

创建后端服务为HTTP的API

1 概述 您需要依次完成以下步骤:创建分组 定义API 创建应用API授权 调试API 调用API 2 创建分组 API分组是API的管理单元,因此需要先创建API分组,然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理,选择Region,点击 ...

ApiInfo

描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...

API调试及自助排错

API网关支持用户对配置在API网关中的已发布API进行在线调试,本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试,而在调试过程中遇到问题时,如何理解报错信息并快速定位和...

ApiPluginSummary

描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...

DeleteApiProduct-删除API产品

删除API产品,会自动删除APIAPI产品的绑定关系(如果存在API产品与APP的授权关系,将删除失败)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...

AttachApiProduct-将API绑定到指定API产品

API绑定到指定的API产品(如果指定的API产品不存在,将自动创建)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出...

API unsupport the channel

API unsupport the channel:HTTP,API 只允许 HTTPS 访问,而发起 API 请求时却使用了 HTTP,则会得到此提示。API unsupport the channel:HTTPS,API 只允许 HTTP 访问,而 API 请求却使用的是HTTPS,则会得到此提示。解决方案:API ...

授权信息

无 bssapi:QuerySettleBill QuerySettleBill Read 全部资源*bssapi:ProductCode bssapi:ProductType 无 bssapi:QuerySplitItemBill QuerySplitItemBill Read 全部资源*bssapi:ProductCode bssapi:ProductType 无 bssapi:SetRenewal ...

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",...

多级API网关

用户在API网关创建的API除了能被客户端调用,还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API,两个API均设置为APP鉴权模式,假设两个API相关属性为:API1:Method:GET Path:/business1 后端地址为:...

DescribeApisByBackend-根据后端查询 API 列表

1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 对象存储 短信服务 视觉智能开放平台 风险识别 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用