API概览

本产品(CloudAPI/2016-07-14)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行对接,或提交工单反馈给我们。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题
CreateInstance创建实例
CreateIntranetDomain创建内部网域
DeleteInstance删除实例
ModifyInstanceSpec网关实例变配

分组

API标题
CreateApiGroup创建API分组
DeleteApiGroup删除 API 分组
ModifyApiGroup修改API分组的信息
DescribeApiGroup查询 API 分组详情
DescribeApiGroups查询 API 分组列表
DescribePurchasedApiGroup获取购买的 API 组
DescribePurchasedApiGroups获取购买的API分组列表

域名

API标题
DeleteDomain删除域名
DeleteDomainCertificate删除域名的SSL证书
SetDomain给指定分组绑定自定义域名
SetDomainCertificate为自定义域名添加SSL证书
SetDomainWebSocketStatus设置域名WebSocket状态
SetWildcardDomainPatterns设置通配符域名模式
DescribeDomain查询自定义域名详情信息
ReactivateDomain更新域名绑定状态

监控

API标题
CreateMonitorGroup创建监控报警分组
DescribeApiLatencyData查询API监控数据中对响应时间统计数据
DescribeApiQpsData查询API监控数据中对QPS的统计数据
DescribeApiTrafficControls查询API流控策略绑定概况
DescribeApiTrafficData查询API监控数据中流量统计数据
DeleteMonitorGroup删除监控分组

API管理

API标题
ModifyApiConfiguration修改API定义
CreateApi创建 API
CreateApiStageVariable创建环境变量
DeleteApi删除 API 定义
DeleteApiStageVariable删除环境的指定变量
ModifyApi修改API定义
DescribeApisByBackend根据后端查询 API 列表
DescribeApi查询 API 定义
DescribeApiMarketAttributes获取API的属性
DescribeApis查询定义中的 API 列表
DescribeApiHistory查询历史版本详情
DescribeApisByApp根据应用查询API列表
DescribeAuthorizedApis查询已授权的API列表
DescribeApiDoc查询API说明文档
DescribeDeployedApi查询API在指定环境中的定义
DescribeHistoryApis查询API发布版本定义列表
DescribePurchasedApis获取购买的 API 列表
DescribeApiHistories查询API历史发布的版本列表
DescribeDeployedApis查询已发布 API 列表
DescribeMarketRemainsQuota描述剩余配额
DescribeDeployApiTask查询发布API任务进度
DescribeAbolishApiTask查询API下线任务
ImportSwagger通过 Swagger 创建 API
AbolishApi下线 API
DeployApi发布 API
BatchDeployApis批量发布API
BatchAbolishApis批量下线API
SwitchApi切换指定环境中正在运行中的API定义
DryRunSwagger预检查swagger

应用

API标题
CreateApp创建APP
DeleteApp删除应用
ModifyApp修改APP应用
DescribeApps查询应用列表
DescribeAppAttributes查询APP列表信息
DescribeAuthorizedApps查询可访问APP列表
DescribeApp查询可授权 APP 列表
DescribeAppSecurity查询指定 APP 的密钥信息
ResetAppCode重置应用

专有网络

API标题
ModifyApiGroupVpcWhitelist修改API分组VPC白名单
SetVpcAccess添加 VPC 授权
DescribeApiGroupVpcWhitelist查询分组VPC白名单
DescribeVpcAccesses查询授权的VPC列表
DescribeUpdateVpcInfoTask查询VPC授权更新状态
RemoveVpcAccess撤销 VPC 授权
RemoveVpcAccessAndAbolishApis删除VPC授权

插件

API标题
CreatePlugin创建API网关插件
DeletePlugin删除插件
AttachPlugin绑定插件到API上
ModifyPlugin修改插件
DescribePluginsByApi查询API上绑定的插件
DescribePluginSchemas描述插件模式
DescribePluginTemplates获取插件模板列表
DescribePlugins查询插件列表
DetachPlugin解绑API绑定的插件

访问控制

API标题
AddIpControlPolicyItem增加IP访问控制策略
CreateIpControl新增IP访问控制
DeleteIpControl删除IP访问控制
ModifyIpControl修改IP访问控制
ModifyIpControlPolicyItem修改IP访问控制下的策略
SetIpControlApis绑定IP访问控制与API关系
DescribeApiIpControls查询API的IP访问控制绑定情况
DescribeIpControlPolicyItems查询IP访问控制策略列表
DescribeIpControls查询IP访问控制列表
DescribeApisByIpControl查询IP访问控制绑定的API
RemoveIpControlApis解除API与IP访问控制的绑定
RemoveIpControlPolicyItem移除IP访问控制的策略

模型

API标题
CreateModel创建模型
DeleteModel删除已有模型
ModifyModel更新模型
DescribeModels获取已创建的模型

权限

API标题
SetApisAuthorities给多个API添加APP访问权限
SetAppsAuthorities给多个APP添加API访问权限
RemoveApisAuthorities撤销应用APP对多个API访问权限
RemoveAppsAuthorities撤销多个APP对指定API的访问权限
ResetAppSecret重置APP的secret

标签

API标题
ListTagResources查询网关资源标签关系
TagResources创建标签资源关系(用户标签)
UntagResources删除用户标签和资源的关系

服务

API标题
DescribeRegions查询支持的区域
DescribeSystemParameters查询系统参数列表
DescribeZones查询地域的可用区列表
OpenApiGatewayService开通服务

日志

API标题
CreateLogConfig创建日志配置
DeleteLogConfig删除日志配置
ModifyLogConfig修改日志配置
DescribeLogConfig获取日志配置

流控

API标题
AddTrafficSpecialControl添加特殊流控配置
CreateTrafficControl创建流控策略
DeleteAllTrafficSpecialControl删除所有特殊流控
DeleteTrafficControl删除指定的用户自定义流控策略
DeleteTrafficSpecialControl删除特殊流控
ModifyTrafficControl修改用户自定义的流控策略设置
SetTrafficControlApis添加指定流控策略与API的绑定
DescribeTrafficControls查询流控策略列表及详情
DescribeTrafficControlsByApi查询API绑定的流控策略
DescribeApisByTrafficControl查询指定流控策略下已绑定API列表信息
RemoveTrafficControlApis解除API与流控策略的绑定

SDK

API标题
SdkGenerateByApp按应用生成SDK
SdkGenerateByGroup按分组生成SDK

签名

API标题
CreateSignature创建签名密钥
DeleteSignature删除后端签名密钥
ModifySignature修改后端签名密钥
SetSignatureApis绑定签名密钥与API
DescribeSignatures查询后端签名密钥列表
DescribeApisBySignature查询签名密钥绑定的API列表
DescribeApiSignatures查询API签名密钥绑定情况
DescribeSignaturesByApi查询API绑定的后端签名密钥
RemoveSignatureApis解除API与后端签名密钥的绑定

后端

API标题
CreateBackend创建后端服务
DeleteBackend删除后端服务
ModifyBackend修改后端服务
DescribeBackendList查询后端服务列表
DescribeBackendInfo查询后端服务的信息
DescribeUpdateBackendTask查询后端服务更新任务

后端模型

API标题
CreateBackendModel创建后端模型
DeleteBackendModel删除后端模型
ModifyBackendModel修改后端模型
阿里云首页 API 网关 相关技术圈