导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
API网关
日志字段 说明 owner_id API提供者的阿里云账号ID apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod HTTP请求方法 path 请求路径 domain 调用...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
HTTP自动跳转HTTPS
您可以通过配置自动跳转功能，将客户端HTTP请求方式强制重定向为HTTPS请求。前提条件 分组已绑定域名并已成功配置HTTPS证书，操作可参考 使用HTTPS并用域名访问。分组内的所有API定义的请求协议都已勾选HTTPS。操作步骤 登录 API网关控制台...
DescribeImportOASTask-查询OAS导入API的任务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
客户端调用API示例
X-Ca-Debug-Info:{"ServiceLatency":0,"TotalLatency":2}#当打开 Debug 模式后会返回 Debug 信息，此信息后期可能会有变更，仅用做联调阶段参考 您调用API时，无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名信息。AppKey用于...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
API概览
本产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来。说明 在进行API调用之前，请先查阅 调用方式 公共请求和返回结果 签名机制，或直接使用我们提供的 Java SDK 示例。流转规则 API 描述 ListRouteRules 查询流转列表 ...
配置记录HTTP请求应答日志
如果需要在日志中记录API网关收到的HTTP的请求及API网关返回给客户端的HTTP应答，您可以在分组详情中进行设置。记录请求Headers：逗号分隔需要记录的Header名称（如上图所示），'*' 记录全部 记录应答Headers：逗号分隔需要记录的Header...
ModifyInstanceAttribute-修改指定实例的信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
跨域资源共享（CORS）
这意味着使用这些API的Web应用程序只能加载同一个域下的资源，除非使用CORS机制（Cross-Origin Resource Sharing 跨源资源共享）获取目标服务器的授权来解决这个问题。上图画的是典型的跨域场景，目前主流浏览器为了用户的安全，都会默认...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
基于Swagger完成API网关与用户CICD流程整合
如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义 步骤2：创建API分组 步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中 步骤4：对API进行各项额外配置 自动...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
数据治理
数据地图血缘展示延迟问题 血缘有最少一天的延迟 数据地图新建表搜不到 若数据地图表和表目前状态不一致，请使用数据地图手工同步功能手动同步该表最新状态。表管理数据地图表结构未更新 新建表在数据地图找不到 数据集成搜不到新建的表 ...
API 管理
},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
发送 HTTP 请求（Java）
填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
概述
了解做为API网关管理员，如何对API授权进行管理和分配 1.API认证方式 使用无认证方式调用API 客户端可以直接调用API，安全性很低，适合临时测试的场景，不建议使用。使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全...
日志字段详情
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...
数据加密
API 网关提供客户端与网关之间数据加密的能力，支持 RSA、ECC、国密三种加密算法，保证数据传输过程中的安全性。说明 目前仅支持对 HTTP 类型的 API 调用进行数据加密。使用流程 根据加密算法，生成密钥。网关管控平台创建应用并开启加密...
API 分组
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
函数计算
API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。1 功能简介 API网关目前支持两种形式的函数，HTTP函数 和 事件函数。2 HTTP函数对接API网关 2.1 创建HTTP函数 在配置API...
API市场服务私网访问
API说明 API公网域名 API计算巢私网域名 源站部署地域 API售卖页地址 生活服务 全国快递物流查询快递查询接口 wuliu.market.alicloudapi.com wuliu.api.market.aliyunnest.com cn-hangzhouhttps://market.aliyun.com/products/57126001/cm...
如何找到已购买的API
您在API市场上购买API之后，即完成API的自动授权。您可以在管理控制台寻找您都已经购买的API。打开 云市场，在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")在...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
通用数据查询与管理
如果需要快速地查找数据，例如查找工作空间、数据源中的表、数据分析和数据服务中的代码或API，您可以在数据地图中进行查找。进入数据地图 登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理>数据地图，在右侧页面中单击...
ModifyApiGroupNetworkPolicy-修改api分组的网络策略
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
CreateBackendModel-创建后端模型
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您