DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
API概览
回收站管理 API 标题 API概述 TrashFile 放入回收站 文件或文件夹放入回收站。ClearRecyclebin 清空回收站 清空回收站中所有文件和文件夹。ListRecyclebin 列举回收站 列举回收站。RestoreFile 恢复文件或文件夹 从回收站恢复文件或文件夹...
名词解释
API消费者可以创建多个API消费凭证，每个凭证可被一个或一组API消费方应用使用，通常可以把凭证作为API消费方应用的分组。API提供方应用 和消费方相对，指接入CSB开放出服务API的提供者应用。API发布者 API提供方应用在CSB上发布服务和管理...
音视频播放
接口调用说明 接口的参数解释和返回字段的详细说明请访问 阿里云OpenAPI门户，在各接口右侧的 文档 页签查看。SDK代码示例，可以通过阿里云OpenAPI门户获取。访问 阿里云OpenAPI门户，在接口的左侧 参数配置 页签，填写需要的参数信息并...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
OpenAPI 门户
使用场景 查看 OpenAPI 文档 OpenAPI 门户 提供完整的 OpenAPI 文档，包含接口说明、流控信息、授权信息、请求参数、返回数据、返回说明、返回示例、错误码、变更历史等。您可通过阅读 OpenAPI 文档判断它是否能够满足您的业务场景。Open...
API 调用返回20003 错误码
1.问题背景 API 在调用时,需要指定域名（domain）、方法（method）、API 版本（version）API 网关也是通过上面3个参数来准确定义和完成请求路由到指定的后台服务 如果上面的三个三有一个不正确,API 网关在路由配置里面并没有找到对应的后台...
常见问题
本文主要介绍自学习工具使用过程中的常见问题。...模型列表里面的模型是所有基于平台训练生成的模型，而模型提取列表里面的模型只是基于本次训练候选模型评估完成后提取的模型。模型列表的模型是所有历次模型提取列表的模型总和。
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
产品架构
API 网关主要由 GW Controller 和 Mosng 两个组件构成，GW Controller 将数据推送给 Mosng 后，Mosng 开始对外提供服务。本文主要结合这两个组件介绍 API 网关架构。API Gateway 系统主要由以下组件构成：GW Controller：网关控制台，负责...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
功能概览
API网关支持以下功能。API 生命周期管理 覆盖设计、开发、测试、发布、运维监测、安全管控、下线等API各个生命周期阶段，API网关为每个阶段提供生产力工具；协议处理 支持HTTPS、SSL卸载、支持HTTP2.0；支持通过泛域名调用API；请求转发 ...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...
客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
通过 JSAPI 调用 MGS RPC 接口向服务端发送 POST 请求...
问题描述 H5 应用需要通过 JSAPI 调用移动网关 API 接口，该接口在业务侧是一个 POST 类型的 API。用户缺少如何在 H5 端构造 POST 请求的操作指示。服务端配置 业务侧 API 描述 假设业务侧 API 描述如下：POST/api/product {"id":0,...
HTTP 转 SOFARPC 入门
步骤五：创建应用 在左侧导航栏单击 API 订阅>应用管理 页，单击列表右上方的 创建应用。在 创建应用 窗口，选择 应用类型 为 应用。输入 应用名称，用于识别应用。本例使用 hello。单击 确定。应用添加完成后，订阅者需在应用详情页，获取...
支持HTTP2.0
API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
导入数据模型
为了方便用户快速生成数据模型，API 网关支持通过 Proto 文件和 Swagger 文件来快速导入数据模型。操作步骤 登录 API 网关控制台。在左侧导航栏单击 API 发布>数据模型，进入数据模型页面。在页面右上角单击 导入数据模型，在弹出的窗口中...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本迭代过程中，新版本服务正式发布前通过API网关进行灰度发布，A/B Test的通用方法实践。该方法的核心是通过配置后端路由插件来确保可以控制服务升级对用户造成的影响。一、概述 灰度发布是指在API的新、旧...
发送 HTTP 请求（NodeJS）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
搭建无服务器应用之手机号归属地查询
本文主要介绍配合使用API网关、函数计算和云市场三种产品，搭建一个可以查询手机号归属地的服务。在这个框架里不需要配置Web容器、不需要搭建运行环境、不需要购买负载均衡，通过配置和一段代码即可完成一个高扩容无服务器的应用服务。服务...
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
外部授权
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。外部授权服务编写须知 您...
RefundInstance-退订实例
RefundInstance：调用本接口退订不再需要的实例。接口说明 退订只退还实付金额的部分，已使用的代金券不退还。请仔细核对退订资源的信息，并确认退订条款和退订金额，资源一经退订无法恢复。其他问题请参照：退订规则 调试 您可以在OpenAPI...
- 产品推荐
- 这些文档可能帮助您