调用API商品

本文适用于您在云市场上购买API商品成功后,如何调用APIAPI认证方式概述 在调用API商品时,首先您需要了解采用哪种API认证方式,云市场API商品的认证方式主要以下两种方式。两种方式可同时使用,您可以根据不同情况来选择。简单身份认证...

AuthorizedApi

AuthorizedApis描述"class="reference-link">描述应用和API的对应关系 节点名"class="reference-link">节点名AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ID...

环境管理

API网关上进行环境管理的时候,您需要做两部分工作:API的后端配置:通过设置 API分组 的 环境变量,为API分组的测试、预发、线上环境分别定义不同值,从而当调用API时,API网关可以调用到不同的后端地址。API的前端调用:需要client端显...

修改 API

此接口面向开放API的用户 该接口需要全量更新,不支持部分参数更新 修改ApiName时需要注意,同一个分组内API不允许重名 修改RequestPath时需要注意,同一个分组内Path不允许重复 该接口调用的QPS限制为:单用户QPS不超过50 调试 您可以在...

查询定义中的 API 列表

默认是1,起始是1 返回参数 名称 类型 描述 RequestId String 本次请求编号 TotalCount Integer 返回结果的总条数 PageNumber Integer 返回指定的页码 PageSize Integer 返回指定的每页条数 ApiSummarys ApiSummary 由 ApiSummary 组成的数...

功能概览

API网关支持以下功能 API 生命周期管理 覆盖设计、开发、测试、发布、运维监测、安全管控、下线等API各个生命周期阶段,API网关为每个阶段提供生产力工具;协议处理 支持HTTPS、SSL卸载、支持HTTP2.0、客户端websocket接入、双向通信;支持...

基于Swagger完成API网关与用户CICD流程整合的最佳实践

如下图所示,一个整合了API网关的通用CICD流程,主要有如下步骤:步骤1:自动从您的API业务代码中获取swaager定义步骤2:创建API分组步骤3:通过API网关的OpenAPI导入API定义,并发布在不同的环境中步骤4:对API进行各项额外配置自动获取...

查询插件下绑定的API

描述查询指定插件下绑定的API信息 此功能面向开放API的用户用于查询指定插件下已经绑定的API列表信息分页返回绑定关系列表中返回的API在对应的环境中可能已经下线 请求参数 名称 类型 是否必须 描述 Action String 是 操作接口名,系统规定...

ApiHisItem

描述"class="reference-link">描述列举API信息项的类型 节点名"class="reference-link">节点名ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...

创建 API

调用CreateApi新建一个API。此接口面向开放API的用户。同一个分组内API不允许重名。同一个分组内Path不允许重复。该接口调用的QPS限制为:单用户QPS不超过50。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行...

快速切换 API 版本

调用SwitchApi指定历史版本切换掉指定环境中正在运行中的API定义,即用历史定义替换运行中定义。此功能面向开放API的用户 历史版本号可通过DescribeHistoryApis接口获取 发布超过1次的API才可以切换 切换针对的是运行中API,切换操作不可逆...

ApiSummary

ApiSummarys描述"class="reference-link">描述API概要信息项 节点名"class="reference-link">节点名ApiSummary 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...

签名密钥绑定 API

调用SetSignatureApis添加指定签名密钥与API的绑定。此功能面向开放API的用户 用于添加API与签名密钥的绑定关系,支持多个API批量操作,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,Open...

解除策略与 API 绑定

调用RemoveTrafficControlApis解除API与流控策略的绑定关系。此功能面向开放API的用户 用于解除API与流控策略的绑定关系,支持API批量,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,Open...

ApiInfo

描述"class="reference-link">描述列举API信息项的类型 节点名"class="reference-link">节点名ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String ...

删除 API 分组

描述用于删除指定的API分组 此功能面向API提供者分组下存在API时,分组不可删除,须先删除分组下的API删除分组后,系统分配给此分组的二级域名自动生效删除不存在的分组时,会返回删除成功该接口调用的QPS限制为:单用户QPS不超过50 请求...

创建 API 分组

描述创建API需要先创建分组,所属分组是API的一个基本属性信息。此功能面向API提供者。每个用户每个区域下最多可创建100个分组。系统自动给分组分配二级域名,用于测试API。分组带有区域属性,后续创建API选择分组后就选择了区域,为减少...

ApiPluginSummary

描述绑定到插件的API概要信息 节点名ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String ...

流控策略与 API 绑定

调用SetTrafficControlApis添加指定流控策略与API的绑定。此功能面向开放API的用户 用于添加API与策略的绑定关系,支持多个API批量操作,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,...

双向通信使用指南

二、双向通信三种管理信令要使用API网关的双向通信能力,首先要了解API网关双向通信相关的三种信令,需要注意的是,这三个信令其实就是API网关上的三个API,需要用户去API网关创建后才能使用。1.注册信令注册信令是客户端发送给用户后端...

解除IP访问控制与 API 的绑定

调用RemoveIpControlApis解除API与IP访问控制的绑定关系。此功能面向开放API的用户 即时生效,解除后该API的对应环境将不会有IP访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI ...

客户端调用API示例

您可以通过 API 网关,调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API您可以直接用API网关控制台为您提供的多语言SDK来调用API(SDK和文档下载),也可以自行编写HTTP(s)请求调用...

VPC内网访问API网关

API网关支持用户通过公网或VPC内网访问API网关,本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时,需要通过每个分组的“内网VPC二级域名”来进行访问,该域名有如下特点:内网VPC二级域名只能在VPC内使用,支持直接访问,且...

IP访问控制

IP 访问控制是 API 网关提供的 API 安全防护组件之一,负责控制 API 的调用来源 IP(支持IP段)。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。白名单,支持配置 IP 或者 APPID+IP 的白名单访问,不在白名单...

专享实例

目前API网关提供了8种实例规格,每个实例规格的性能参数如下表所示:实例规格最大入访每秒请求数(RPS)最大入访连接数最大入访每秒新建连接数(CPS)最大出访连接池大小最大公网入访带宽(bps)最大公网出访带宽(bps)SLAapi.s1.small...

修改 API 分组

描述用于修改已经存在的API分组的名称或者描述 此功能面向API提供者该接口调用的QPS限制为:单用户QPS不超过50 请求参数 名称 类型 是否必须 描述 Action String 是 接口名称,系统规定参数,取值:ModifyApiGroup GroupId String 是 API...

给指定 app 添加多个 API 的访问权限

此功能面向API提供者和API使用者 API提供者可以授权自己的API给任意应用(app)调用 API使用者可以将已购买的API授权给自己的应用(app)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI ...

IP访问控制绑定API

调用SetIpControlApis添加指定IP访问控制与API的绑定关系。此功能面向开放API的用户 支持多个API批量操作,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK...

解除签名密钥与 API 的绑定

调用RemoveSignatureApis解除API与后端签名密钥的绑定关系。此功能面向开放API的用户 即时生效,解除后网关到后端服务的请求将不带有签名字符串,请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名...

查询 API 历史版本列表

默认值为10 StageName String 否 RELEASE 环境名称,可选值:RELEASE:线上 TEST:测试 返回数据 名称 类型 示例值 描述 ApiHisItems Array 由 ApiHisItem 组成的数组格式,返回API的信息 ApiHisItem 由 ApiHisItem 组成的数组格式,返回...

插件绑定API

描述绑定插件到API上 此接口面向开放API的用户绑定操作只能选择发布状态的API绑定以后及时生效修改插件后及时生效 请求参数 名称 类型 是否必须 描述 Action String 是 操作接口名,系统规定参数,取值:AttachPlugin PluginId String 是 ...

IP访问控制

IP 访问控制是 API 网关提供的 API 安全防护组件之一,负责控制 API 的调用来源 IP(支持IP段)。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。白名单,支持配置 IP 或者 APPID+IP 的白名单访问,不在白名单...

使用函数计算做为API后端服务

当请求设置函数计算为后端服务的 API 时,API 网关会触发相应的函数,函数计算会将执行结果返回给 API 网关。1 功能简介 API 网关与函数计算对接,可以让您以 API 形式安全地对外开放您的函数,并且解决认证、流量控制、数据转换等问题...

支持 HTTPS

可以在【开放API】-【API列表】找到相应API,【API定义】-编辑-【请求基础定义】中进行修改。API支持的协议包括:HTTP:只允许HTTP访问,不允许HTTPS HTTPS:只允许HTTPS访问,不允许HTTP HTTP和HTTPS:两者均可,调整后,API支持HTTPS协议...

流量控制策略

流量控制策略和 API 分别是独立管理的,操作两者绑定后,流控策略才会对已绑定的 API 起作用。在已有的流量控制策略上,可以额外配置特殊用户和特殊应用(APP),这些特例也是针对当前策略已绑定的API生效。流量控制策略可以配置对 API、...

查询 API 服务文档

此功能面向调用API的用户,指定的API必须是发布到运行环境,且Visibility=PUBLIC的API或者被授权的Visibility=PRIVATE的API若您是调用API的用户,该接口返回您指定的API的服务信息及参数定义等详情信息。若您是开放API的用户,那么调用该...

分组的域名绑定

用户使用API网关对外提供服务时,需要使用自己拥有的域名开放自己的能力,本文主要描述如何将用户自己的域名绑定到API网关上,让客户端使用自己的域名来调用其开放的API。1.概述1.1 域名与分组、API之间的关系用户需要将自己拥有的域名绑定...

ApiIpControlItem

描述列举API上IP访问控制信息项的类型 节点名ApiIpControlItem 子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间

创建数据服务API

使用场景包括:最小粒度的数据输出:当企业需要对外提供数据时,相较于直接对外提供表数据,使用API的方式可以控制到行级(SQL过滤条件)和列级(查询字段),这样能帮助用户只对外暴露最小单元的数据,保障数据安全。可视化制作:对于多数...

SDK下载及使用指南

若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务(包括在 API 市场购买的 API 服务)注意这里的 API 服务是指在 API 市场购买的,或者您在 API 网关接入开放的,或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
< 1 2 3 4 ... 200 >
跳转至: GO

新品推荐

你可能感兴趣

热门推荐

新人福利专场 阿里云试用中心 企业支持计划 飞天会员助力企业低成本上云 智能财税30天免费试用 云解析DNS新用户首购低至36元/年起 ECS限时升级特惠6.5折