API网关提供哪些API接口_API 网关(API Gateway)-阿里云帮助中心

本产品（API 网关/2016-07-14）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

内网域名解析

API	标题	API概述
DissociateInstanceWithPrivateDNS	解除内网域名解析和专享实例的关联	解除内网域名解析和专享实例的关联
DeletePrivateDNS	删除内网域名解析	删除内网域名解析
AssociateInstanceWithPrivateDNS	关联内网域名解析到专享实例	关联内网域名解析到专享实例
CreatePrivateDNS	创建内网域名解析	创建内网域名解析，添加解析记录
ListPrivateDNS	查询内网域名解析	查询内网域名解析，支持根据内网域名或解析类型查询。
UpdatePrivateDNS	修改内网域名解析	修改内网域名解析

实例

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的更新进度。
ValidateVpcConnectivity	VPC授权连通性测试	测试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	生成与App关联的API的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分组的网络。
DescribeApisByVpcAccess	通过Vpc授权信息查询绑定该VPC授权的API信息	查询指定地域内指定api的访问控制绑定情况。
DeleteAppCode	删除App的AppCode	删除指定App的AppCode。
DeleteAppKey	删除App的AppKey和AppSecret	删除指定App的AppKey和AppSecret。
CreateAppCode	App添加AppCode	给App添加AppCode。
CreateAppKey	App添加AppKey和AppSecret	App添加AppKey和AppSecret。
DescribeInstanceClusterInfo	查询专享实例集群信息	查询专享实例集群信息。
DescribeInstanceClusterList	查询专享实例集群	查询专享实例集群列表。
DescribeAppSecurities	查询App的密钥信息	查询App的密钥信息。
ExportOAS	导出OAS定义	导出OAS。