SwitchApi-切换指定环境中正在运行中的API定义
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
DescribeApis-查询定义中的 API 列表
32 ApiSummarys object[]由 ApiSummary 组成的数组格式，返回 API 的定义信息 Visibility string 可见性，可选值：PUBLIC：公开 PRIVATE：私有 PUBLIC ApiId string API 编号 5af418828f0344a3b588c0cc1331a3bc ModifiedTime string 修改...
DescribeDeployedApi-查询API在指定环境中的定义
查询指定API在指定环境中正在运行的定义，是真正在指定环境中生效的定义，可能跟正在编辑中的定义不同。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
DeleteApi-删除 API 定义
接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
ModifyApi-修改API定义
修改API的定义信息。接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS ...
DescribeApi-查询 API 定义
查询指定API的定义。接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在...
DescribeHistoryApis-查询API发布版本定义列表
调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
使用Gateway API定义路由规则
本文介绍如何使用Gateway API定义集群内应用的路由规则。前提条件 已添加集群到ASM实例，且ASM实例版本为1.18及以上。已部署入口网关服务，且网关已开启80和443端口。已部署httpbin应用。具体操作，请参见 部署httpbin应用 的 步骤1。使用...
使用Gateway API定义路由规则
本文介绍如何使用Gateway API定义集群内应用的路由规则。前提条件 已添加集群到ASM实例，且ASM实例版本为1.18及以上。已部署入口网关服务，且网关已开启80和443端口。已部署httpbin应用。具体操作，请参见 部署httpbin应用 的 步骤1。使用...
API基础定义是什么
可以配置您 API 被访问的方式，包含：http 或 https ，以及使用 HTTP 方法，目前网关支持所有标准的 HTTP 方法。
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
导出标准OAS定义
勾选导出API网关扩展字段后，在API网关定义API以外的内容，如绑定的插件、授权的APP、分组的域名、后端服务在各环境上的定义等，均不会导出。示例 如下为使用API网关提供的分组导出带有扩展定义的OAS2.0内容：swagger:'2.0' info:...
API网关中API分组的自定义域名设置了SSL证书
API网关中的API分组绑定自定义域名，且设置了SSL证书，视为“合规”。应用场景 为自定义域名设置SSL证书，对信息和数据进行加密，用来保证数据传输的安全。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级...
版本管理
说明 当您需要编辑某个API的定义时，如果该API已经发布，对定义的修改不会对线上产生影响，定义修改后需要再次发布才能把修改后的定义同步到线上环境。2 对比差异 API编辑后您可以通过 对比差异 功能来与之前发布的API进行配置对比，确认...
导入标准OAS定义
OperationId：对应API定义的API名称，如果存在扩展字段“x-aliyun-apigateway-api-name”则使用扩展字段中的内容作为API的名称；Schemes：对应API定义中请求部分支持的协议，优先级高于Swagger Object中的定义；Parameter Object：Name：...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
I404NF错误码排查
您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么请求API的Path应该是/test/nameid。若您API定义的Method配置为POST，那么请求...
产品简介
API 网关是金融分布式...提供 API 的全生命周期管理，包括 API 的定义、测试、发布、版本管理等。提供 API 的安全保障能力，包括身份认证、数据加密、流量控制、访问控制等安全措施。提供 API 的可视化监控功能，帮助更好的运维和管理 API。
数据服务概述
数据服务基于Serverless架构，您无需关注服务器、网络等运行环境相关的基础设施，只需专注于API的定义、数据的查询逻辑，从而避免传统架构带来的运维成本开销。数据服务与API网关（API Gateway）完全集成，支持您将数据服务快速发布到API...
API概览
DescribeApi 查询 API 定义 查询指定API的定义。DescribeApiMarketAttributes 获取API的属性 查询API上云市场属性。DescribeApis 查询定义中的 API 列表 查询定义中的API列表。DescribeApiHistory 查询历史版本详情 查询指定API的某一次...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
步骤一：资源准备
在创建API的 定义API后端服务 配置向导页，填写Mock的返回信息。后端配置 选择 自定义后端服务，后端服务类型 选择 Mock，Mock的返回结果 如下所示，HTTP Status Code 配置为 200。在 Mock Header 区域，单击 新增一条，Header Name 为 ...
管理应用
在 API 订阅列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 定义、请求参数、响应示例、错误码 等详细信息。筛选 API 协议类型：单击 API 协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
API网关的审计事件
DescribeApisByApp 按应用查询定义中的API列表。DescribeApisByBackend 根据后端查询API列表。DescribeApisByIpControl 查询IP访问控制绑定的API。DescribeApisByRule 通过规则获取API列表。DescribeApisByRuleForConsole 通过规则获取API...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
TCP连接超时时间配置
具体配置 上文说到的ClientReadTimeout需要在客户端的初始化HttpClient连接池的代码中配置，拿API网关提供的SDK举例，在下面代码中配置：上文说到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：
后端路由
backend:后端描述，与API网关的Swagger标准保持一致，后端在原有API的后端上覆盖backend配置后处理，如果覆盖后的backend不完整，会提示客户端 X-Ca-Error-Code:I504RB，当看到这个错误时，请检查自己的backend配置是否完整，关于Backend...
后端服务调不通
如果使用的是内网 IP，请保证您的后端服务与您的 API 处于同一地域。检查您API定义的“后端超时”时间。在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以...
HTTP自动跳转HTTPS
分组内的所有API定义的请求协议都已勾选HTTPS。操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
对象存储
说明 需要声明在API请求里定义的API请求的HTTP Method会影响可以调用的OSS方式，目前网关支持OSS的HTTP Method有GET，PUT，POST，HEAD，DELETE，对应OSS的请求方式如下：GET：GetObject PUT：PutObject POST：PostObject,AppendObject HEAD...
上传API至API网关
尽管插件做了很多推测，但仍应使用明确的声明定义API。声明精确的请求方法，使用@PostMapping 和@GetMapping，而不是@RequestMapping。使用@PostMapping 时，需声明精确的consumes。consumes对应HTTP请求的Content-Type，Content-Type中...
上传API至API网关
尽管插件做了很多推测，但仍应使用明确的声明定义API。声明精确的请求方法，使用@PostMapping 和@GetMapping，而不是@RequestMapping。使用@PostMapping 时，需声明精确的consumes。consumes对应HTTP请求的Content-Type，Content-Type中...
使用外部授权 API
对应外部授权 API 的定义标准如下：AuthRequest publicclassAuthRequest{ privateMap,String>context;} AuthResponse publicclassAuthResponse{ privateboolean success;privateMap,String>principal;privateMap,String>failResponseHeader...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
管理API
说明 由于在DMS控制台定义的API与API网关集成，因此发布后的API，可在API网关的控制台中看到，但不可编辑。步骤三：测试API API发布后，您可以在API测试页签下，查看调用API的返回结果是否符合预期。在 API测试 页签下，单击下拉列表选择...
- 产品推荐
- 这些文档可能帮助您