acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
变更时间：2025-02-14 变更集发布说明：OpenAPI 名称 变更内容概要 操作 ListPrivateDNS OpenAPI 入参发生变更。查看变更详情 查看API文档 变更时间：2025-02-12 变更集发布说明：OpenAPI 名称 变更内容概要 操作 ModifyApiGroup OpenAPI ...
HTTP API基于HTTP协议的接口，可以快速对外暴露分布式系统的内部服务，本文将指导您如何通过控制台来创建基于HTTP协议的API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，选择 API管理，并在顶部菜单栏选择地域。单击 创建API，在...
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布 API 管理 ...
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API。目前有两种方式：通过管控API导入Swagger创建，具体参考 ImportSwagger-通过 ...
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布 API 分组，进入分组列表。单击...
DATASOURCE:ApiGateway:Apps 查询应用列表。DATASOURCE:ApiGateway:Groups 查询当前存在的API分组列表及基本信息。DATASOURCE:ApiGateway:Instance 查询单个实例信息。DATASOURCE:ApiGateway:Instances 查询实例列表。
4.设置API分组的报警规则 如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。点击确定后，会提示云...
在API列表中，单击目标API，进入API详情页，在 接口列表，选择需要编辑的接口，单击 编辑接口。在 编辑接口 面板中，可修改接口基本信息及API定义。在线调试API 登录 云原生API网关控制台。在左侧导航栏，选择 API，并在顶部菜单栏选择地域...
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
前提条件 已完成API创建并添加接口。具体操作，请参见 创建REST API并添加接口。已发布API。具体操作，请参见 发布API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，单击 API，并在顶部菜单栏选择地域。在API列表中，选择目标API，...
变更时间：2025-02-10 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetMqConsumerTag OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。查看变更详情 查看API文档 CloseTicket OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更。...
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
前提条件 已完成API创建并添加接口。具体操作，请参见 创建REST API并添加接口。已发布API。具体操作，请参见 发布API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，单击 API管理，并在顶部菜单栏选择地域。在API列表中，单击需要...
本篇文档介绍原API网关支持的多种API认证方式，包括使用简单认证（AppCode）方式调用API、使用摘要签名认证方式调用API、基于JWT的token认证，以及授权管理，确保了API调用的安全性和灵活性。使用简单认证（AppCode）方式调用API API网关...
本文旨在为您详细介绍如何通过控制台在云原生API网关中创建AI API，并有效...管理AI API AI API适用于面向人工智能应用开发的团队，提供了更加灵活和智能的AI网关配置和调试能力。如何创建、更新和使用AI API。具体详情，请参见 管理AI API。
alicloud_api_gateway_app_attachment 将指定API的访问权限授予多个应用程序。alicloud_api_gateway_backend 在API网关中创建后端服务。alicloud_api_gateway_group 创建API分组。alicloud_api_gateway_log_config 创建日志配置。alicloud_...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
本文介绍云市场上API商品的构成，以及如何将自己的API发布在API网关上并上架到云市场的操作步骤。概览 适用对象 本文适用于云市场...API接口的信息。商品介绍信息，包括产品亮点、产品说明、产品参数、售后支持范围、商品价格，使用指南等。
发布完成后，由于API的认证方式是 阿里云APP，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
REST API主要面向以业务为中心的开发团队，适用于API First、API精细化管理等场景，支持通过控制台、AI大模型或者基于OpenAPI 导入的方式创建。本文主要介绍如何创建REST API并添加接口。概述 API是一个整体的服务定义，定义了如何与系统...
REST API支持版本管理，本文介绍如何通过控制台添加API版本，并切换至目标API版本。前提条件 已完成REST API创建并添加接口。具体操作，请参见 创建REST API并添加接口。使用背景 在REST API中进行版本管理是一项重要的实践，它有助于保持...
您可以参考API接口ImportSwagger，或在控制台上进行操作。详细内容包括：Swagger扩展：Swagger扩展主要是对于swagger原生 Operation Object 进行扩展，增加认证、参数映射以及后端服务等扩展。兼容性说明：Swagger参数类型与原有API网关...
在 已经授权API的SDK/文档自动生成 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。在左侧导航栏的 API调用 SDK 中，选择 分组API，在 SDK/文档自动...
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API。如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档。使用JWT认证方式调用API 还可...
步骤二：添加接口 在API列表中单击目标API，在API详情页，添加接口：如果目标API开启了版本管理，需要先选择 版本，后单击 添加接口。如果目标API未开启版本管理，单击 添加接口。在 创建接口 面板中，配置接口相关参数，并单击 创建。配置...
acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
本文将快速引导您如何在API网关中，发布后端服务为事件总线类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建后端服务。创建API分组。定义API。创建应用和API授权。调试API。调用API。前提...
本文介绍在API网关控制台如何管理API。1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：登录 API网关控制台。单击左侧导航栏的 API管理 API列表。选择需要查看的API单击操作列下的 管理。您可以看到当前所选API的定义信息。按照...
API监控和告警 原API网关的监控和告警，包括以下内容：API网关监控 API网关的监控支持查看region（地域）、分组、以及API的监控图表，详细内容包括：Region监控 实例监控（仅专享实例）分组监控 API监控 API报警设置 您可以通过云监控对...
本篇文档介绍了在原API网关中实现私网调用的方法，包括VPC内网访问API网关和函数计算内网访问API网关。VPC内网访问API网关 API网关支持用户通过公网或VPC内网访问API网关，详细内容包括：Serverless实例设置方式：API网关的Serverless实例...
当您的业务需要即时交互时，您可以通过云原生API网关控制台创建WebSocket API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，选择 API管理，并在顶部菜单栏选择地域。单击 创建API，在创建API弹框中单击 WebSocket API 卡片中的 创建...
名称 类型 描述 示例值 object 按照 API 名称分组的 API 列表。name string API 名称。test-api versionEnabled boolean 是否开启版本管理。true versionedHttpApis array 版本化的 API 版本信息。HttpApiApiInfo API 信息。type string ...
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
绑定 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。解绑 ...