Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
InvalidRamRole.NoPermission 原因：该RAM角色未进行CC API的RAM授权 解决方案：授予该角色CC API的RAM权限，可授予系统权限策略或者对应API的权限。InvalidResourceType.NotFound 原因：用户传入的资源类型不存在或尚未支持。解决方案：...
生成方式 系统生成：系统为您自动生成API Key凭证。自定义：自定义API Key凭证及凭证来源。凭证 自定义API Key凭证。凭证来源 凭证来源用于网关从请求的提取参数的位置和名称，支持如下：Authorization:Bearer token 自定义 HTTP Header ...
通过云原生API网关实例，可以实现服务暴露、流量管理、安全防护和API全生命周期管理等功能，本文介绍如何创建云原生API网关实例。基础配置 首次开通，需授权 系统权限策略：AliyunServiceRoleForNativeApiGw：允许访问ACK、VPC、SLB、MSE等...
路由路径相比API接口往往粒度较粗，如/user/*，这样可快速配置访问路径，实现系统间的交互。HTTP API主要面向开发或运维团队，通过路由可以快速实现业务逻辑的拆分和服务的交互，有较高的灵活性，简化业务系统间的调用逻辑。创建HTTP API ...
通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API。目前有两种方式：通过管控API导入Swagger创建，具体参考 ImportSwagger-通过 ...
接口说明 此功能面向开放 API 的用户 此接口返回定义 API 时可选择接收的系统参数列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表...
用户系统如何应用JWT插件保护API。颁发token的认证服务示例代码。API网关错误应答列表。授权管理 API网关的API授权管理指应用（APP）与API之间建立授权关系。详细内容包括：创建应用（APP）：应用（APP）是调用API的身份。API授权：应用...
使用SDK调用API 通过调用API网关自动生成的SDK，您可在业务系统中调用已经发布的API。详细内容包括：下载SDK 在左侧导航栏的 API调用 SDK 中，选择 已授权API页签。在 已经授权API的SDK/文档自动生成 中下载应用APP的SDK，此SDK是基于APP...
API监控和告警 原API网关的监控和告警，包括以下内容：API网关监控 API网关的监控支持查看region（地域）、分组、以及API的监控图表，详细内容包括：Region监控 实例监控（仅专享实例）分组监控 API监控 API报警设置 您可以通过云监控对...
步骤一：创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的...
本文将快速引导您如何在API网关中，发布后端服务为事件总线类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建后端服务。创建API分组。定义API。创建应用和API授权。调试API。调用API。前提...
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档。调用API的前期步骤可...
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
解决了访问域名问题后，就需要做系统集成了，云原生API网关提供了SDK下载，可以在API详情页面直接下载该API下所有接口的调用代码。5.正式业务灰度迁移 通过严格的功能验证后，用户就可以逐渐将业务从原API网关迁移到云原生API网关了，整个...
API 网关为网络隔离的系统间提供高性能、高安全、高可靠的通信。满足企业对外部合作伙伴开放业务的同时，帮助客户更好的进行场景和业务的创新。网关主要功能模块如下：API 全生命周期管理 快速构建多种协议类型的 API 支持按需导入导出 API...
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
配置流程 使用API网关访问VPC内部的后端服务API，具体配置流程如下：创建VPC授权 创建分组 创建API 创建应用和API授权 安全组放行网关出口地址 调试API 调用API 创建VPC授权 如果您想让API网关能够访问VPC，则需要创建VPC授权。登录 API...
Nginx Ingress 和 APIG Ingress的功能特性和应用场景等均有所不同。本文通过产品定位、产品架构、性能、基础路由等几个维度的对比，以便根据两者差异进行Ingress网关选型。Nginx Ingress：基于开源Nginx构建的K8s Ingress网关，是 ...
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
2.使用环境 2.1 API后端服务环境配置 在API网关的使用上，我们推荐通过后端服务来统一管理API的后端业务应用，并支持通过环境来区分不同环境下的后端应用。后端服务的介绍和创建，请参见 使用后端服务提高管理效率。2.2 API发布指定环境 ...
说明 当应用创建成功后，系统会自动给应用分别配一个 APPID，可在 API 订阅 应用管理 中的应用详情页查看。对于内部系统的应用，您需要输入其 应用名称，可自动获取其 APPID 与类型。所属公司/部门：可选，用于识别应用所属的公司或部门。...
系统入参信息项的类型 描述 节点名 SystemParameter 子节点 ParameterName String 系统参数名，取值为：CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy、CaApiName、CaClientUa、...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 TicketId string 是 工单...
下线后，API 状态切换为 未发布，无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击 下线 确认。在 API 详情页面，单击右上角的 下线 按钮。在 API 详情 版本管理 页签中...
API管理是阿里云API网关的专业服务，为API设计、发布、运维提供全生命周期管理。本文系统阐述其核心功能、产品优势与应用场景，助您高效构建与运维API，加速业务创新。
API网关专享实例支持开通IPv6能力，开通后，系统会为实例分配公网IPv6入访地址以及公网IPv6出访地址。前提条件 已创建API网关专享实例。概述 API网关专享实例支持开通IPv6入口能力以及出访能力，如图。IPv6入口能力：开通后，系统会为实例...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 TicketId string 是 工单号...
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
异构系统集成场景 统一集成 降低企业内部系统集成的成本，无缝连接不同的软件应用程序。遗留系统兼容 允许 IT 团队选择最适合技术栈，在转型过程中并且可以兼容遗留系统，加速企业转型升级。集中管理 IT 团队可以从更集中的位置访问所有...
HTTP API基于HTTP协议的接口，可以快速对外暴露分布式系统的内部服务，本文将指导您如何通过控制台创建HTTP API。适用场景 云原生API网关提供了实例内和实例外两种创建API的方式，分别适用以下场景：实例内创建API 资源的专用管理：API仅需...
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为 阿里云APP认证。应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 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...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ProductId long 是 产品 ID...
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
Model API消费者鉴权通过API key的认证方式验证调用者的身份，精准控制 API 访问权限，实现多租户细粒度管控，保障敏感数据隔离与合规调用，有效防止未授权访问和资源滥用。策略说明 安全性：防止未授权访问：消费者鉴权通过验证请求者的...
Agent API消费者认证通过API key和JWT的认证方式验证调用者的身份，精准控制 API 访问权限，实现多租户细粒度管控，保障敏感数据隔离与合规调用，有效防止未授权访问和资源滥用。策略说明 安全性：防止未授权访问：消费者鉴权通过验证请求...