概述

角色说明 API 网关产品涉及以下两个角色:API 发布者:将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者:使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下:...

导入导出 API

批量导出 API 在 API 发布>API 管理 页面,在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出 按钮,即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API 在 API 发布>API 管理 页面,单击 API 列表右上方的 ...

创建 API 分组

在左侧导航栏单击 API 发布>API 分组,进入分组列表。单击 API 分组列表右上方的 创建分组 按钮。在弹出窗口中,配置 API 分组信息:分组名称:必填,用于识别 API 分组。支持英文字母、中文、数字、下划线(_)、连字符(-),32 个字符...

简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

获取服务端信息

为了让客户端与网关建立连接,您必须在 API 网关控制台上获取以下信息:应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中,应用在环境中的唯一标识...

创建授权对象

在 API 订阅者创建应用后,API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理,进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中,选择或输入相关...

基础术语

中文 释义 API 应用程序编程接口,是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组,同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识,用于定位在访问的 API。...

批量操作API

注意事项 批量修改API基础配置后,可一键发布API发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据,没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用(APP)。...

DeployedInfo

描述"class="reference-link">描述 API发布信息项的类型 节点名"class="reference-link">节点名 DeployedInfo 子节点"class="reference-link">子节点 名称 类型 描述 StageName String 环境名称,取值为:RELEASE、TEST EffectiveVersion ...

发布API

在完成API测试后,您可以将API发布至API网关进行托管,实现对API设计、开发、测试、发布、运维监测、安全管控以及下线等全生命周期管理。同时,您也可以将API上架至阿里云API市场,快速实现数据价值的变现,最终形成商业闭环。本文为您介绍...

API使用规范

API 本规范中“API”指:阿里云向您提供的应用程序编程接口(Application Programming Interface,简称API),您编程后通过该应用程序编程接口,可获取阿里云提供的弹性计算服务(ECS)、关系数据库服务(RDS)和对象存储服务(OSS)等阿里...

创建应用

这个应用就是一个订阅对象,API 发布者给该应用授权后,便可将该应用和 API 关联在一起。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 订阅>应用管理,进入应用列表。单击应用列表右上方的 创建应用。在弹出的 创建应用 窗口中,...

阿里云OpenAPI

API应用程序编程接口)是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务,使开发者更容易地实现连接两个应用程序之间的功能,也使开发人员可以更轻松地开发和扩展应用程序。Open...

事件总线

在本例创建API的时候,认证方式选择的是“阿里云APP认证“,因此在API发布后,还需要创建APP,并将APP和API的对应关系建立好,才能够正常访问。创建应用 在API网关控制台左侧导航栏选择 API管理-应用管理,创建一个APP。可以看到阿里云APP...

创建后端为函数计算的API

API返回内容为前面步骤中创建的函数返回内容,函数代码如下:7 调用API 通过上述步骤,您已经创建API、创建APP、建立了授权关系,调试API完成,并将API发布到线上环境,本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...

I404NF错误码排查

这个报错是请求的Path或Method和API定义的不同,需要根据...如果API发布的环境并非线上,调用时需要指定调用环境。如果要调用测试环境,请在header中增加参数:X-Ca-Stage:TEST。如果要调用预发环境,请在header中增加参数:X-Ca-Stage:PRE。

创建后端服务为HTTP的API

6 调用API 通过上述步骤,您已经创建API、创建APP、建立了授权关系,调试API完成,并将API发布到线上环境,本阶段将会模拟如何通过调用API网关提供的SDK,来在您的业务系统中调用发布好的API。步骤11 调用API 1、在 API调用 中找到 SDK,...

绑定/解绑授权对象

绑定授权对象 进入 API 发布>API 管理 页面,找到待授权的 API,单击进入其详情页。在 授权对象 标签页下,单击 绑定授权对象,进入 添加授权应用 窗口。对于已添加为授权对象的订阅方应用,您可以直接在授权对象列表中搜索找到。对于暂未...

创建参数映射

操作步骤 进入 API 网关控制台页面,在左侧导航栏中选择 API 发布>参数映射。在参数映射列表页,单击列表右上方的 创建参数映射。在新打开的 创建参数映射 页面中,选择或输入相关信息:参数映射名称:必填,用于识别参数映射规则。支持...

创建数据模型

操作步骤 进入 API 网关控制台页面,在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页,单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中,配置如下信息:模型名称:必填,用于识别数据模型,需保证唯一性。...

产品优势

多种客户端接入支持 同一个 API 发布后,既支持 mPaaS 移动端 iOS 和 Android 的应用接入,也支持非移动端小程序、H5、Web、后端应用应用接入。多协议/多语言异构集成 支持不同语言,不同技术栈实现的业务系统之间进行无缝集成,支持协议...

跨域资源访问(CORS)

本文提供了域资源访问的示例。关于CORS跨域资源访问的基础知识可参考 跨域资源共享(CORS)。插件配置 可以选择JSON者YAML格式的来配置您的插件,两种格式的schema相同,...如果API发布的是测试环境,可以通过绑定测试域名来实现跨域请求。

创建服务项目

因此,在API绑定应用或者被组合API引用后,API发布新版本到线上时,会与线上的版本进行对比,如果存在以上四种变更,可以选择不同的处理机制。您可基于API的使用场景,针对不同项目下的API灵活使用发布管控机制。支持 绑定应用或者被组合...

创建后端服务为VPC内资源的API

在本例中的步骤1中,认证方式选择的是"阿里云APP认证",因此在API发布后,还需要创建APP,并将APP和API的对应关系建立好,才能够正常访问。步骤9 创建应用 在 API管理 菜单中选择 应用管理,创建一个APP,如下图所示。可以看到阿里云APP下...

创建系统集群

SOFARPC 协议类型 进入 API 网关控制台页面,左侧导航栏选择 API 发布>系统集群。在系统集群列表页面,单击右上方的 创建系统集群。在新弹出窗口中,配置下图中信息:系统集群名称:必填,用于识别系统集群,支持英文字母、中文、数字、...

导入数据模型

在左侧导航栏单击 API 发布>数据模型,进入数据模型页面。在页面右上角单击 导入数据模型,在弹出的窗口中配置数据模型信息。选择导入类型:API 网关提供Swagger 和 ProtoBuf 两种数据模型的导入,您可以根据实际业务需求进行选择。Swagger...

概述

4.开发者指南(OpenAPI)插件管理相关的OPENAPI如下:创建插件:CreatePlugin 修改插件:ModifyPlugin 删除插件:DeletePlugin 查询插件:DescribePlugins 绑定API插件:AttachPlugin 解绑API插件:DetachPlugin 查询插件绑定的APIs:...

测试API

在生成API时,如果需要将API发布至API网关进行托管,您需要完成对API的测试,验证调用API时的请求参数和返回结果是否符合预期;同时您也可以对已发布的API进行测试。本文为您介绍如何测试开发中和已发布的API。背景信息 API测试本质上是...

发送 HTTP 请求(NodeJS)

已将该应用的 APPID 提供给了 API 发布者,并获得了授权,参见 授权 API。已获取了如下服务配置信息。具体获取方法,参见 获取服务端信息。应用的访问密钥(Access Key/Secret Key)API 的域名地址(host)、请求路径(path)、方法...

使用 RAM 管理 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...

API网关灰度发布最佳实践

API网关客户在应用迭代过程中会不断有新版本API发布,在新版本正式发布前,可以使用灰度流量控制先进行小规模验证,将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行,通过收集使用体验的数据,对应用新版本的...

SOFARPC 客户端接入

已将该应用的 APPID 提供给了 API 发布者,并获得了授权,参见 授权 API。已获取了如下服务配置信息。具体获取方法,参见 获取服务端信息。应用的访问密钥(Access Key/Secret Key)。API 的域名地址(host)、接口名称(interface)、方法...

发送 HTTP 请求(Java)

已将该应用的 APPID 提供给了 API 发布者,并获得了授权,参见 授权 API。已获取了如下服务配置信息。具体获取方法,参见 获取服务端信息。应用的访问密钥(Access Key/Secret Key)API 的域名地址(host)、请求路径(path)、方法...

授权API

API发布后,您可以将API授权给他人,或获取他人已授权的API,以实现数据共享。本文为您介绍如何对API进行授权及不同场景下API的授权方案。前提条件 仅支持对已发布的API进行下线、授权和变更协议等操作,详情请参见 发布API。进入API管理...

发送 HTTP 请求(C#)

已将该应用的 APPID 提供给了 API 发布者,并获得了授权,参见 授权 API。已获取了如下服务配置信息。具体获取方法,参见 获取服务端信息。应用的访问密钥(Access Key/Secret Key)API 的域名地址(host)、请求路径(path)、方法...

DescribeApi-查询 API 定义

name ServiceParameterName string 后端参数名称 name DeployedInfos object[]API 发布状态 StageName string 环境名称,取值为:RELEASE、TEST RELEASE EffectiveVersion string 有效的版本 xxx DeployedStatus string 部署状态,取值为:...

调用API

API发布后,您可前往API网关控制台下载SDK,然后在应用中使用该SDK调用API,或构造URL调用API。调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和...

API网关为K8s容器应用集群提供强大的接入能力

很容易地升级应用程序容器的新版本 提供容器弹性,如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的,但是Kubernetes集群没有足够的接入能力,特别在大型应用中,它是不能够...

DataWorks数据服务

发布并查看API。在API编辑页面,单击顶部菜单栏右侧的 发布。发布API至API网关,并上架至API市场,详情请参见 发布API。在 数据服务 页面,单击顶部菜单栏右侧的 服务管理。单击已发布的API名称,查看API详情。调用API。如果您需要调用已...

自定义服务API

重要 API发布后,API Path不支持修改。API标签 输入标签内容后,按回车键,生成标签。支持中文、英文字母、数字、下划线(_)和短划线(-)。长度不超过30个字符。使用标签功能,为API自定义标识,以便灵活管理API。重要 一个API最多可添加...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 视觉智能开放平台 风险识别 对象存储 短信服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用