在API列表中，单击目标API，进入API详情页，在 接口列表，选择需要编辑的接口，单击 编辑接口。在 编辑接口 面板中，可修改接口基本信息及API定义。在线调试API 登录 云原生API网关控制台。在左侧导航栏，选择 API，并在顶部菜单栏选择地域...
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
前提条件 已完成API创建并添加接口。具体操作，请参见 创建REST API并添加接口。已发布API。具体操作，请参见 发布API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，单击 API，并在顶部菜单栏选择地域。在API列表中，选择目标API，...
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
前提条件 已完成API创建并添加接口。具体操作，请参见 创建REST API并添加接口。已发布API。具体操作，请参见 发布API。操作步骤 登录 云原生API网关控制台。在左侧导航栏，单击 API管理，并在顶部菜单栏选择地域。在API列表中，单击需要...
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
alicloud_api_gateway_app_attachment 将指定API的访问权限授予多个应用程序。alicloud_api_gateway_backend 在API网关中创建后端服务。alicloud_api_gateway_group 创建API分组。alicloud_api_gateway_log_config 创建日志配置。alicloud_...
REST API主要面向以业务为中心的开发团队，适用于API First、API精细化管理等场景，支持通过控制台、AI大模型或者基于OpenAPI 导入的方式创建。本文主要介绍如何创建REST API并添加接口。概述 API是一个整体的服务定义，定义了如何与系统...
REST API支持版本管理，本文介绍如何通过控制台添加API版本，并切换至目标API版本。前提条件 已完成REST API创建并添加接口。具体操作，请参见 创建REST API并添加接口。使用背景 在REST API中进行版本管理是一项重要的实践，它有助于保持...
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
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...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
步骤二：添加接口 在API列表中单击目标API，在API详情页，添加接口：如果目标API开启了版本管理，需要先选择 版本，后单击 添加接口。如果目标API未开启版本管理，单击 添加接口。在 创建接口 面板中，配置接口相关参数，并单击 创建。配置...
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
当您的业务需要即时交互时，您可以通过云原生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。单击页面底部的 确认，即可完成绑定。解绑 ...
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2（北京）...ap-southeast-2 apigateway.ap-southeast-2.aliyuncs....
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 API列表。3.选择需要查看的API点击操作列下 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮...
云原生API网关支持API设计、开发、测试、发布、下线等生命周期管理。
接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...
ApiSummarys 描述"class="reference-link">描述 API概要信息项 节点名"class="reference-link">节点名 ApiSummary 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...
API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
AuthorizedApis 描述"class="reference-link">描述 应用和API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 BackendId string 是 后端...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
名称 类型 示例 描述 data BOOLEAN true,false data 更新授权应用限流 sofa.apigateway.api.authapplimit.update 用于更新指定授权应用的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 否 api_id1 API 标识 auth_app_...
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
名称 类型 描述 示例值 object API 信息。httpApiId string HTTP API ID。api-xxx name string API 名称。test protocols array API 协议列表。string 协议。枚举值：HTTPS ： HTTPS 。HTTP ： HTTP 。HTTP basePath string API 基础路径。...