中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
云控制 API 是一款免费的OpenAPI开发者工具套件。让开发者能够调用风格一致的OpenAPI实现资源的生命周期管理。
本文适用于订阅方使用 SOFARPC 作为客户端接入 API 网关。前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并...
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段...重要 API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作。
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
RELEASE:线上 PRE:预发 TEST:测试 RELEASE 返回参数 名称 类型 描述 示例值 object ApiId string API 编号 4eed13a57d4e42fbb51316be8a5329ff ResultType string 后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。...
PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上...
true ServiceConfig object 网关向后端服务发送 API 请求的相关配置项 AoneAppName string aone 应用名称 ib-blank MockStatusCode integer Mock 返回状态码 200 ContentTypeValue string 调用后端服务 HTTP 服务，ContentTypeCatagory 的...
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
RELEASE:线上 PRE:预发 TEST:测试 RELEASE HistoryVersion string 历史版本号 20211022134156663 ApiName string Api 名称 测试API BackendEnable boolean 是否启用后端服务 true BackendConfig object 后端配置 BackendId string 后端服务...
②环节（API网关向后端服务发起请求）中，在不同的后端服务类型和组网情况下：后端服务类型 API网关和后端服务的网络连通情况 步骤2产生的流程是否计为公网出访流量 HTTP(s)服务 后端服务位于非阿里云的环境中，需要通过互联网访问 是 后端...
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
通过日志服务查看API调用日志 API网关和日志服务实现无缝集成，通过日志服务您可以进行实时日志查询、下载、多维度统计分析等。详细内容包括：日志在线查询：可根据日志中任意关键字进行快速的精确、模糊检索，可用于问题定位或者统计查询...
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
本文介绍在API网关控制台如何管理API。1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：登录 API网关控制台。单击左侧导航栏的 API管理 API列表。选择需要查看的API单击操作列下的 管理。您可以看到当前所选API的定义信息。按照...
概述 用户的客户端调用API网关的引擎，API网关的引擎调用用户的后端服务，...后端服务 API后端定义 路由插件 如果在这三个地方都配置了后端服务超时时间属性（APIGatewayBackendTimeout），那么生效的优先级为：路由插件 API后端定义 后端服务
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
云控制API 云控制 API 是一款免费的OpenAPI开发者工具套件。让开发者能够使用一致的OpenAPI和一个开发者工具包来管理和集成阿里云上百款产品。功能集 功能 功能描述 参考文档 元数据查询 产品信息查询 用户通过此接口查询Cloud Control API...
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
数据服务 API网关支持数据服务，能为企业搭建统一的数据服务总线，提升数据资产的价值，同时确保数据的可靠性、安全性和有效性。使用场景包括：最小粒度的数据输出。可视化制作。加工后的数据供应用读取。提供数据服务的阿里云产品 大数据...
步骤一：创建后端服务 API网关允许将后端服务配置为region内的资源，简化管理流程。您只需在API网关控制台新建后端服务，并在其环境中配置不同的后端服务地址。随后，在创建API时，直接选用已配置的后端服务即可。登录 API网关控制台，并在...
API网关监控 API网关的监控支持查看region（地域）、分组、以及API的监控图表，详细内容包括：Region监控 实例监控（仅专享实例）分组监控 API监控 API报警设置 您可以通过云监控对发布在API网关上的API配置报警，以便随时了解API服务运行...
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
本篇文档介绍原API网关支持的多种API认证方式，包括使用简单认证（AppCode）方式调用API、使用摘要签名认证方式调用API、基于JWT的token认证，以及授权管理，确保了API调用的安全性和灵活性。使用简单认证（AppCode）方式调用API API网关...
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。客户端和服务器可以把HTTP消息分解为互不依赖的帧，然后...
步骤八：编写 API 调用代码 获取如下服务配置信息：在订阅方应用详情页获取该应用的密钥（Access Key/Secret Key）。在 API 详情页获取该 API 的域名（host）、请求路径（path）与方法（method）。编写调用代码，此处以 Java 代码为例：...
使用API网关对外提供服务时，您可以使用自己拥有的域名来开放对外提供服务的能力，本文主要介绍如何将自己的域名绑定到API网关上，让客户端使用域名来调用其开放的API。概述 域名与分组、API之间的关系 用户需要将自己拥有的域名绑定到API...
请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息，当请求出现错误时API网关会通过响应头...
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
步骤八：编写 API 调用代码 获取如下服务配置信息：在订阅方应用详情页获取该应用的密钥（Access Key/Secret Key）。在 API 详情页获取该 API 的域名（host）、请求路径（path）与方法（method）。编写调用代码，示例如下：说明 如果 API ...
3.2.2.API定义导入 原API网关和云原生API网关都支持标准的OAS协议，您只需要将API定义从原API网关上导出成API定义文件（OAS协议），然后在云原生API网关进行导入就可以：在原API网关导出整个分组的API定义，文档参考 导出标准OAS定义。...
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
场景三 API网关内网访问部署在IDC机房的后端服务 本场景客户端为杭州ecs，API网关为杭州专享实例，后端服务部署在杭州的IDC机房。访问链路均为内网。架构图如下：主要配置过程如下：实现本地数据中心到阿里云接入点vpc-1的内网互通；创建...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别是在大型应用中，它是不能够...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(S)请求...