This topic describes how to create and publish an API with EventBridge as the backend service in API Gateway.This topic also describes how to call the API by using the Alibaba Cloud App authentication method and using the ...
The API group synchronization feature helps you quickly synchronize API definitions between API groups.Before you start synchronizing,we recommend that you familiarize yourself with the information to be and not to be ...
Description For listing the types of API information items.Node name DeployedApiItem.Subnodes Name Type Description RegionId String ID of the region where the API is located.GroupId String API group ID.GroupName String API...
WebSocket API基于WebSocket协议，允许客户端和服务器之间进行双向通信，是构建实时应用（如聊天、实时通知、游戏等）的理想选择。本文将指导您如何通过控制台创建WebSocket API。适用场景 云原生API网关提供了实例内和实例外两种创建API的...
导入标准OAS定义 API网关支持导入OAS 2.0和OAS3.0格式的API定义，也支持导入扩展后的OAS定义，您可以快速将现有系统的API接入网关。使用现有API定义文件，无需修改就可以在API网关中配置并管理这些API。详细内容包括：标准OAS2.0格式与API...
本篇文档介绍了如何通过调用API网关自动生成的SDK来实现API调用，并提供了客户端调用API的相关示例。使用SDK调用API 通过调用API网关自动生成的SDK，您可在业务系统中调用已经发布的API。详细内容包括：下载SDK 在左侧导航栏的 API调用 SDK...
Description For listing the types of API information items.Node name ApiHisItem.Subnodes Name Type Description RegionId String Region where the API is located.GroupId String API group ID.GroupName String API group name....
Change time:2025-12-18 Changeset Release Notes:OpenAPI name Summary of changes Operation GetResourceOverview The response structure of the API has changed.View Change Details View API Documentation Change time:2025-12-17 ...
VPC内网目前支持三种情况：VPC内网访问API网关，配置请参考 VPC内网访问API网关。函数计算内网访问API网关，配置请参考 函数计算内网访问API网关。同Region的API自调用默认走内网，详情请参考 多级API网关。3.授权管理 若创建API认证方式为...
You can use CloudMonitor to configure alerting for APIs that are published in API Gateway.This way,you can track the running status of APIs at all times to ensure the stability of the APIs.1.Associate resources The ...
the integration between API Gateway and a CI/CD process is to encapsulate and integrate the management operations provided by API Gateway.The following process shows a general CI/CD process integrated with API Gateway:Step...
see"API Gateway API Reference".action-name Description Resource CreateApiGroup Creates an API group.acs:apigateway:$regionid:$accountid:apigroup/*ModifyApiGroup Modifies an API group.acs:apigateway:$regionid:$accountid:api...
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
APIG Ingress功能介绍 管理APIG Controller组件 为APIG Controller授权 通过APIG Ingress访问ACK托管集群 APIG Ingress支持的Annotation APIG Ingress高级用法 Nginx Ingress和APIG Ingress网关对比 配置ApigConfig APIG Ingress使用说明 ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
本文介绍在API网关控制台如何管理API。1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：登录 API网关控制台。单击左侧导航栏的 API管理 API列表。选择需要查看的API单击操作列下的 管理。您可以看到当前所选API的定义信息。按照...
API监控和告警 原API网关的监控和告警，包括以下内容：API网关监控 API网关的监控支持查看region（地域）、分组、以及API的监控图表，详细内容包括：Region监控 实例监控（仅专享实例）分组监控 API监控 API报警设置 您可以通过云监控对...
VPC内网访问API网关 API网关支持用户通过公网或VPC内网访问API网关，详细内容包括：Serverless实例设置方式：API网关的Serverless实例支持内网访问，并允许同一地域内所有用户的VPC进行访问。专享实例设置方式：专享实例的VPC内网访问能力...
名称 类型 描述 示例值 object 按照 API 名称分组的 API 列表。name string API 名称。test-api versionEnabled boolean 是否开启版本管理。true versionedHttpApis array 版本化的 API 版本信息。HttpApiApiInfo API 信息。type string ...
绑定 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。解绑 ...
This topic provides answers to some frequently asked questions(FAQ)about API groups.API group issues How many API groups can I create?How do I select a region to create an API group?How many domain names can I bind to an ...
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
This topic provides answers to some frequently asked questions(FAQ)about calling APIs in the original API Gateway.API call issues Can I migrate APIs between a serverless instance and a shared instance?How does an API ...
native API Gateway supports publishing two types of APIs:shared API and instance-scoped API.Shared API Log on to the Cloud-native API Gateway console.In the left-side navigation pane,select API,and select a region in the ...
名称 类型 描述 示例值 object APIKEY 身份认证配置。type string 类型。Apikey apikeySource object APIKEY 来源配置。source string APIKEY 来源。枚举值：Header：Header参数。QueryString：Query参数。Default：默认。Default value ...
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
描述 API概要信息项 节点名 ApiSummary 子节点 RegionId String 所在的region。GroupId String API分组编号。GroupName String API分组名称。ApiId String API编号。ApiName String API名称。Description String API描述。Visibility ...
版本管理 是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。开启 版本管理 功能后，需要配置 使用方式。说明 选择 使用方式 为 Query 时...
Asia Pacific Region name Region ID Public network access address ...2 apigateway.ap-northeast-2.aliyuncs.com China (Qingdao)cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com China (Beijing)...
通过控制台创建REST API 云原生API网关 提供了实例内和实例外两种创建API的方式：实例外API 登录 云原生API网关控制台。单击左侧导航栏 API，并在顶部菜单栏选择地域。单击 创建API。单击 REST API 卡片中的 创建，在 创建REST API 面板中...
route,and API Effective API Select the API to which the operation or route belongs.operation and route Effective Version If versioning is enabled for the REST API,select a version.This parameter is required only if you set...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...
描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...
描述 应用和API的对应关系 节点名 AuthorizedApi 子节点 RegionId String API所在区域。GroupId String API分组 ID，系统生成，全局唯一。GroupName String API分组名称。StageName String API环境，取值：RELEASE：线上。TEST：测试。...