文档

API概览

更新时间:
本产品(API 网关/2016-07-14)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
CreateInstance创建实例创建API网关实例。
DeleteInstance删除实例删除API网关实例。
ModifyInstanceAttribute修改指定实例的信息修改API网关实例属性。
ModifyInstanceSpec网关实例变配API网关实例升降配置变更接口。
EnableInstanceAccessControl设置实例上的访问控制本功能为API网关专享实例提供实例级别的访问控制能力; 设置实例上的访问控制。
DisableInstanceAccessControl关闭实例上的访问控制本功能为API网关专享实例提供实例级别的访问控制能力; 关闭实例上的访问控制。
DescribeInstances查询实例列表查询region下的共享实例/专享实例详情。

分组

API标题API概述
ModifyIntranetDomainPolicy修改分组内网VPC域名策略修改分组的内网VPC域名策略。
CreateApiGroup创建API分组创建API分组。
DeleteApiGroup删除 API 分组删除指定的API分组。
ModifyApiGroup修改API分组的信息修改已经存在的API分组的名称,描述,或者basepath。
DescribeApiGroup查询 API 分组详情查询API分组的详情信息,包含分组系统自动生成的二级域名、自定义域名及SSL证书信息。
DescribeApiGroups查询 API 分组列表查询当前存在的API分组列表及基本信息。
DescribePurchasedApiGroup获取购买的 API 组获取云市场购买的 API 分组详情。
DescribePurchasedApiGroups获取购买的API分组列表获取云市场购买的 API 分组列表。

域名

API标题API概述
DeleteDomain删除域名解除绑定在分组的自定义域名。
DeleteDomainCertificate删除域名的SSL证书删除指定域名的SSL证书。 此功能面向API提供者。 删除不存在的SSL证书,会返回成功。 指定的分组不存在,会报错:InvalidGroupId.NotFound。 删除SSL证书后,将不能支持HTTPS访问,请谨慎操作。
SetDomain给指定分组绑定自定义域名给指定API分组绑定自定义域名。
SetDomainCertificate为自定义域名添加SSL证书为指定自定义域名上传SSL证书。
SetDomainWebSocketStatus设置域名WebSocket状态开通或关闭自定义域名的WebSocket。
SetWildcardDomainPatterns设置通配符域名模式为绑定的自定义域名设置泛域名模板。
DescribeDomain查询自定义域名详情信息查询绑定的自定义域名详情信息,包含系统自动分配的二级域名、自定义域名和SSL证书信息。
ReactivateDomain更新域名绑定状态重新激活合法状态为异常的自定义域名。

监控

API标题API概述
CreateMonitorGroup创建监控报警分组为指定API分组开启云监控报警。
DeleteMonitorGroup删除监控分组删除API分组对应的云监控的应用分组。
DescribeApiLatencyData查询API监控数据中对响应时间统计数据查询指定API监控数据中对响应时间的统计数据。
DescribeApiQpsData查询API监控数据中对QPS的统计数据查询指定API监控数据中对QPS的统计数据。
DescribeApiTrafficControls查询API流控策略绑定概况查询指定分组指定环境下所有API的流控策略绑定概况。
DescribeApiTrafficData查询API监控数据中流量统计数据查询指定API监控数据中对流量的统计数据。
DescribeInstanceDropPacket获取实例丢弃的数据数查看专享实例一定时间内丢弃数据包数。
DescribeInstanceDropConnections获取实例的丢失链接查看专享实例一定时间内丢失的连接数。
DescribeInstanceHttpCode获取实例HTTP代码查看专享实例一定时间内请求的HTTP状态码分布。
DescribeInstanceLatency获取实例时延查看专享实例一定时间内平均延时。
DescribeInstanceNewConnections查询实例的新连接数查看专享实例一定时间内新建连接数。
DescribeInstancePackets获取实例的数据包数查看专享实例一定时间内流入流出数据包数。
DescribeInstanceQps查询实例的QPS数据查看专享实例一定时间内请求次数。
DescribeInstanceSlbConnect获取实例的Slb链接查看专享实例一定时间内并发连接数。
DescribeInstanceTraffic查询指定实例流量信息查看专享实例一定时间内请求和应答流量。
DescribeGroupQps查询指定分组的 QPS 数据查询指定的分组在一段时间内请求量的统计信息。

API管理

API标题API概述
CreateApi创建 API新建一个 API。
CreateApiStageVariable创建环境变量在某运行环境下增加变量。
ImportOAS通过OAS导入API使用标准OAS定义导入API。
ImportSwagger通过 Swagger 创建 API通过导入符合阿里云 Swagger 规范的文本内容创建 API。
DeleteApi删除 API 定义删除指定的API定义。
DeleteApiStageVariable删除环境的指定变量删除指定环境的指定变量。
ModifyApiConfiguration修改API定义本API用于修改API的草稿定义信息,区别于接口ModifyApi,不需要填充所有的API信息才能操作,只需指定要修改的参数进行修改。例如,当需要修改API的认证方式从匿名变为APP认证,只需要传入AuthType的值APP即可。
ModifyApi修改API定义修改API的定义信息。
DescribeApisByBackend根据后端查询 API 列表查询使用该后端服务创建的草稿态API,或已发布在某个环境上的API。
DescribeApi查询 API 定义查询指定API的定义。
DescribeApiMarketAttributes获取API的属性查询API上云市场属性。
DescribeApis查询定义中的 API 列表查询定义中的API列表。
DescribeApiHistory查询历史版本详情查询指定API的某一次历史发布版本的定义详情,即某一次历史发布时发布的API定义。
DescribeApisByApp根据应用查询API列表根据APP查询关联的API列表。
DescribeAuthorizedApis查询已授权的API列表查询指定 APP 已授权的API列表,即指定 APP 的API列表。
DescribeApiDoc查询API说明文档查询指定API的服务说明文档。
DescribeDeployedApi查询API在指定环境中的定义查询指定API在指定环境中正在运行的定义,是真正在指定环境中生效的定义,可能跟正在编辑中的定义不同。
DescribeHistoryApis查询API发布版本定义列表查询API历史发布版本列表。
DescribeImportOASTask查询OAS导入API的任务查询OAS批量导入API的结果。
DescribePurchasedApis获取购买的 API 列表获取在云市场购买的 API 列表。
DescribeApiHistories查询API历史发布的版本列表查询指定API历次历史发布的版本列表。
DescribeDeployedApis查询已发布 API 列表查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。
DescribeMarketRemainsQuota描述剩余配额给购买者查询订购关系剩余次数。
DescribeDeployApiTask查询发布API任务进度查询发布API的异步任务的进度。
DescribeAbolishApiTask查询API下线任务查询API下线任务的进度。
AbolishApi下线 API下线指定运行环境的指定API。
DeployApi发布 API发布API到指定的运行环境。
BatchDeployApis批量发布API批量发布API到预发/测试/线上环境。
BatchAbolishApis批量下线API批量下线已经发布到环境的API。
SwitchApi切换指定环境中正在运行中的API定义指定历史版本切换掉指定环境中正在运行中的API定义,即用历史定义替换运行中定义。
DryRunSwagger预检查swagger使用swagger导入swagger之前先预先检查swagger的语法是否规范。

应用

API标题API概述
CreateApp创建APP创建API网关的APP。
DeleteApp删除应用删除指定APP。
ModifyApp修改APP应用修改指定APP应用。
DescribeApps查询应用列表查询应用列表,非APP拥有者会隐藏APP的信息。
DescribeAppAttributes查询APP列表信息查询APP列表及基本信息。
DescribeAuthorizedApps查询可访问APP列表查询当前的应用(APP)列表。
DescribeApp查询可授权 APP 列表查询可授权的 APP 列表,为开发者在操作授权时提取 APP 信息。
DescribeAppSecurity查询指定 APP 的密钥信息该密钥在调用API时要用作身份认证。
ResetAppCode重置应用重置应用的AppCode。此接口每个用户每分钟只能调一次。

专有网络

API标题API概述
RemoveVpcAccess撤销 VPC 授权仅删除VPC授权,不做下线关联API的修改。
RemoveVpcAccessAndAbolishApis删除VPC授权删除VPC授权并下线关联的已经发布在线上的API。
ModifyVpcAccessAndUpdateApis修改VPC授权信息,并且更新关联的API的元信息修改VPC授权信息并更新关联的API元信息。
ModifyApiGroupVpcWhitelist修改API分组VPC白名单修改API分组VPC专有网络白名单。
SetVpcAccess添加 VPC 授权创建VPC授权,开通反向访问。
DescribeApiGroupVpcWhitelist查询分组VPC白名单查询API分组允许访问的VPC白名单。
DescribeVpcAccesses查询授权的VPC列表查询已授权的VPC列表。
DescribeUpdateVpcInfoTask查询VPC授权更新状态更新VPC授权会异步更新关联的发布中的API,该API用来查询这些API的更新进度。
ValidateVpcConnectivityVPC授权连通性测试测试API网关到指定VPC授权中指定实例的指定端口的网络连通性。

访问控制策略

API标题API概述
CreateAccessControlList创建访问控制策略本功能为API网关专享实例提供实例级别的访问控制能力; 创建访问控制策略,每个用户每个region下只允许创建5个访问控制策略。
DeleteAccessControlList删除访问控制策略本功能为API网关专享实例提供实例级别的访问控制能力; 删除访问控制策略。
SetAccessControlListAttribute修改访问控制策略名称本功能为API网关专享实例提供实例级别的访问控制能力; 修改访问控制策略名称。
AddAccessControlListEntry添加IP条目本功能为API网关专享实例提供实例级别的访问控制能力; 在实例的访问控制策略中添加IP条目。
RemoveAccessControlListEntry删除IP条目本功能为API网关专享实例提供实例级别的访问控制能力; 在实例的访问控制策略中删除IP条目。
DescribeAccessControlListAttribute查看访问控制策略详情本功能为API网关专享实例提供实例级别的访问控制能力; 查看访问控制策略详情。
DescribeAccessControlLists查询访问控制策略列表本功能为API网关专享实例提供实例级别的访问控制能力; 查看访问控制策略列表。

插件

API标题API概述
CreatePlugin创建API网关插件新建API网关插件。
DeletePlugin删除插件删除某个插件。
AttachPlugin绑定插件到API上将API和插件建立绑定关系。
ModifyPlugin修改插件修改插件信息。
DetachPlugin解绑API绑定的插件解绑API绑定的插件。
DescribePluginApis查询插件绑定的API列表查询插件绑定的API列表。
DescribePluginsByApi查询API上绑定的插件查询指定环境指定API上绑定的一组插件,该API在该环境必须是运行中状态。
DescribePluginSchemas描述插件模式描述API网关支持的插件模式。
DescribePluginTemplates获取插件模板列表
DescribePlugins查询插件列表查询插件列表及详情。

自定义数据集

API标题API概述
CreateDataset创建数据集创建用户自定义数据集。
CreateDatasetItem创建数据集条目创建用户自定义数据集的数据条目。
DeleteDataset删除数据集删除用户自定义数据集。
DeleteDatasetItem删除数据集条目删除用户自定义数据集的数据条目。
ModifyDataset修改数据集修改用户自定义数据集名称。
ModifyDatasetItem修改数据集条目修改用户自定义数据集的数据条目的超时时间和描述。
DescribeDatasetInfo查询数据集信息查询单个数据集信息。
DescribeDatasetList查询数据集列表查询用户自定义数据集列表。
DescribeDatasetItemInfo查询数据集条目信息查询用户自定义数据集的数据集条目信息。
DescribeDatasetItemList查询数据集条目列表查询用户自定义数据集的数据条目列表。

模型

API标题API概述
CreateModel创建模型在API分组的模型管理中创建模型。
DeleteModel删除已有模型删除API分组的模型管理中的模型。
ModifyModel更新模型更新API分组的模型。
DescribeModels获取已创建的模型获取API分组已创建的模型。

权限

API标题API概述
SetApisAuthorities给多个API添加APP访问权限给指定app添加多个API的访问权限。
SetAppsAuthorities给多个APP添加API访问权限给多个 APP 添加指定 API 的访问权限。
RemoveApisAuthorities撤销应用APP对多个API访问权限撤销指定应用(app)对多个API的访问权限。
RemoveAppsAuthorities撤销多个APP对指定API的访问权限撤销多个APP对指定API的访问权限,多个APP一个API。
ResetAppSecret重置 app 密钥重置指定app的密钥。

标签

API标题API概述
ListTagResources用户查询标签接口查询可见的资源标签关系。
TagResources创建标签资源关系(用户标签)创建标签资源关系(用户标签)。
UntagResources删除用户标签和资源的关系删除用户标签和资源的关系。

服务

API标题API概述
DescribeSummaryData获取摘要数据查看API网关在指定region下的资源数量。
DescribeRegions查询支持的区域查询可以使用的阿里云地域。
DescribeSystemParameters查询系统参数列表查询系统支持的公共参数。
DescribeZones查询地域的可用区列表查询指定地域中可用区的列表。
OpenApiGatewayService开通服务开通网关服务。

日志

API标题API概述
CreateLogConfig创建日志配置为API创建日志服务的配置。
DeleteLogConfig删除日志配置删除指定的日志配置。
ModifyLogConfig修改日志配置
QueryRequestLogs获取请求日志查询用户的操作日志记录。
DescribeLogConfig获取日志配置

SDK

API标题API概述
SdkGenerateByAppForRegion按应用生成SDK
SdkGenerateByApp按应用生成SDK按APP应用生成SDK。
SdkGenerateByGroup按分组生成SDK按API分组生成SDK。

后端

API标题API概述
CreateBackend创建后端服务在API网关创建后端服务。
DeleteBackend删除后端服务删除后端服务。
ModifyBackend修改后端服务修改后端服务的基本信息如名称,描述,后端服务类型一经创建无法修改。
DescribeBackendList查询后端服务列表查询后端服务列表,可以根据后端服务名称和后端服务类型进行过滤。
DescribeBackendInfo查询后端服务的信息查询后端服务的信息以及在各个环境上配置的后端地址。
DescribeUpdateBackendTask查询后端服务更新任务修改后端服务在某个环境上的定义时,关联的已发布API会批量更新,该接口用来查询更新的结果。

后端模型

API标题API概述
CreateBackendModel创建后端模型创建后端服务在环境上的配置。
DeleteBackendModel删除后端模型删除后端服务在某个环境上的定义,删除后,使用该后端服务并发布在此环境上的API都会下线。
ModifyBackendModel修改后端模型修改后端服务在环境上的定义,修改后,使用该后端服务并发布在此环境上的API的后端地址都会批量更新,无需手动发布。

签名插件(经典网络实例)

API标题API概述
CreateSignature创建签名密钥创建后端签名密钥。
DeleteSignature删除后端签名密钥删除API网关后端签名密钥。
ModifySignature修改后端签名密钥修改API网关后端签名密钥。
SetSignatureApis绑定签名密钥与API添加指定签名密钥与API的绑定。
DescribeSignatures查询后端签名密钥列表查询API网关后端签名密钥列表。
DescribeApisBySignature查询签名密钥绑定的API列表查询指定签名密钥所绑定的API列表信息。
DescribeApiSignatures查询API签名密钥绑定情况查询指定分组指定环境下,所有API的签名密钥绑定情况。
DescribeSignaturesByApi查询API绑定的后端签名密钥查询指定API已绑定的后端签名密钥。
RemoveSignatureApis解除API与后端签名密钥的绑定解除API与后端签名密钥的绑定关系。

流控插件(经典网络实例)

API标题API概述
AddTrafficSpecialControl添加特殊流控配置在指定流控策略下添加用户自定义特殊流控策略。
CreateTrafficControl创建流控策略创建用户自定义的流控策略。
DeleteAllTrafficSpecialControl删除所有特殊流控删除指定流控策略下用户所有自定义的特殊流控策略。
DeleteTrafficControl删除指定的用户自定义流控策略删除指定的用户自定义流控策略,以及该策略包含的特殊流控策略。
DeleteTrafficSpecialControl删除特殊流控删除指定的用户自定义特殊流控策略。
ModifyTrafficControl修改用户自定义的流控策略设置修改用户自定义的流控策略设置。
SetTrafficControlApis添加指定流控策略与API的绑定添加指定流控策略与API的绑定。
DescribeTrafficControls查询流控策略列表及详情查询用户自定义的流控策略列表及详情信息,支持条件查询。
DescribeTrafficControlsByApi查询API绑定的流控策略查询指定API已绑定的流控策略。
DescribeApisByTrafficControl查询指定流控策略下已绑定API列表信息查询指定流控策略下已绑定的API列表信息。
RemoveTrafficControlApis解除API与流控策略的绑定解除API与流控策略的绑定关系。

访问控制插件(经典网络实例)

API标题API概述
AddIpControlPolicyItem增加IP访问控制策略向某个已存在的IP访问控制增加一条策略。
CreateIpControl新增IP访问控制在某个地域下新增IP访问控制。
DeleteIpControl删除IP访问控制删除某个已存在的IP访问控制。
ModifyIpControl修改IP访问控制修改某个已存在的IP访问控制。
ModifyIpControlPolicyItem修改IP访问控制下的策略修改某个IP访问控制下的某条策略。
SetIpControlApis绑定IP访问控制与API关系添加指定IP访问控制与API的绑定关系。
DescribeApiIpControls查询API的IP访问控制绑定情况查询指定分组指定环境下,所有API的IP访问控制绑定情况。
DescribeIpControlPolicyItems查询IP访问控制策略列表分页查询某IP访问控制下的策略列表。
DescribeIpControls查询IP访问控制列表调用DescribeIpControls分页查询用户自定义的IP访问控制列表。
DescribeApisByIpControl查询IP访问控制绑定的API查询指定IP访问控制所绑定的API列表信息。
RemoveIpControlApis解除API与IP访问控制的绑定解除API与IP访问控制的绑定关系。
RemoveIpControlPolicyItem移除IP访问控制的策略移除某个IP访问控制下的一条或多条策略。

其他

API标题API概述
DescribeApisWithStageNameIntegratedByApp根据应用查询API列表,返回环境聚合的结果根据应用查询API列表,返回环境聚合的结果。
DescribeGroupLatency查询分组的平均延迟查询指定分组指定环境下,分组的平均延迟。
DescribeGroupTraffic查询分组流量查询指定api分组的流量。
ModifyApiGroupInstance修改api分组所属的实例
ModifyApiGroupNetworkPolicy修改api分组的网络策略修改api分组的网络。
DetachApiProduct解除API与API产品的绑定关系解除API与API产品的绑定关系
SetApiProductsAuthorities批量授权API产品给指定APP批量授权API产品给指定APP
DescribeApiProductsByApp根据APP查询有权限的API产品列表根据APP查询有权限的API产品列表
DescribeApiProductApis查询API产品绑定的API列表查询API产品绑定的API列表
DescribeAppsByApiProduct根据API产品查询授权了的APP列表根据API产品查询授权了的APP列表
AttachApiProduct将API绑定到指定API产品将API绑定到指定的API产品(如果指定的API产品不存在,将自动创建)
DeleteApiProduct删除API产品删除API产品,会自动删除API与API产品的绑定关系(如果存在API产品与APP的授权关系,将删除失败)
RemoveApiProductsAuthorities批量移除API产品对指定APP的授权批量移除API产品对指定APP的授权
SetAppsAuthToApiProduct批量授权多个APP给指定API产品批量授权多个APP给指定的API产品
DescribeApisByVpcAccess通过Vpc授权信息查询绑定该VPC授权的API信息查询指定地域内指定api的访问控制绑定情况。
DeleteAppCode删除App的AppCode删除指定App的AppCode。
DeleteAppKey删除App的AppKey和AppSecret删除指定App的AppKey和AppSecret。
CreateAppCodeApp添加AppCode给App添加AppCode。
CreateAppKeyApp添加AppKey和AppSecretApp添加AppKey和AppSecret。
DescribeInstanceClusterInfo查询专享实例集群信息查询专享实例集群信息。
DescribeInstanceClusterList查询专享实例集群查询专享实例集群列表。
DescribeAppSecurities查询App的密钥信息查询App的密钥信息。
  • 本页导读 (1)