实例
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
CreateInstance | 创建API网关实例 | 查看文档去调试 |
| DescribeInstances | 查询region下的共享实例/专享实例详情 | 查看文档去调试 |
| ModifyInstanceAttribute | 修改API网关实例属性 | 查看文档去调试 |
| ModifyInstanceSpec | API网关实例升降配置变更接口 | 查看文档去调试 |
| EnableInstanceAccessControl | 本功能为API网关专享实例提供实例级别的访问控制能力； 设置实例上的访问控制 | 查看文档去调试 |
| DisableInstanceAccessControl | 本功能为API网关专享实例提供实例级别的访问控制能力； 关闭实例上的访问控制 | 查看文档去调试 |
| DeleteInstance | 删除API网关实例 | 查看文档去调试 |
| ModifyInstanceVpcAttributeForConsole | 修改实例的客户端所在VPC | 查看文档去调试 |
分组
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateApiGroup | 创建API分组 | 查看文档去调试 |
| DescribeApiGroup | 查询API分组的详情信息，包含分组系统自动生成的二级域名、自定义域名及SSL证书信息 | 查看文档去调试 |
| DescribeApiGroups | 查询当前存在的API分组列表及基本信息 | 查看文档去调试 |
| DescribePurchasedApiGroup | 获取云市场购买的 API 分组详情 | 查看文档去调试 |
| DescribePurchasedApiGroups | 获取云市场购买的 API 分组列表 | 查看文档去调试 |
| ModifyIntranetDomainPolicy | 修改分组的内网VPC域名策略 | 查看文档去调试 |
| ModifyApiGroup | 修改已经存在的API分组的名称，描述，或者basepath | 查看文档去调试 |
| DeleteApiGroup | 删除指定的API分组 | 查看文档去调试 |
域名
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDomain | 查询绑定的自定义域名详情信息，包含系统自动分配的二级域名、自定义域名和SSL证书信息 | 查看文档去调试 |
| SetDomain | 给指定API分组绑定自定义域名 | 查看文档去调试 |
| SetDomainCertificate | 为指定自定义域名上传SSL证书 | 查看文档去调试 |
| SetDomainWebSocketStatus | 开通或关闭自定义域名的WebSocket | 查看文档去调试 |
| SetWildcardDomainPatterns | 为绑定的自定义域名设置泛域名模板 | 查看文档去调试 |
| DeleteDomain | 解除绑定在分组的自定义域名 | 查看文档去调试 |
| DeleteDomainCertificate | 删除指定域名的SSL证书。 此功能面向API提供者。 删除不存在的SSL证书，会返回成功。 指定的分组不存在，会报错：InvalidGroupId.NotFound。 删除SSL证书后，将不能支持HTTPS访问，请谨慎操作 | 查看文档去调试 |
| ReactivateDomain | 重新激活合法状态为异常的自定义域名 | 查看文档去调试 |
监控
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateMonitorGroup | 为指定API分组开启云监控报警 | 查看文档去调试 |
| DescribeApiLatencyData | 查询指定API监控数据中对响应时间的统计数据 | 查看文档去调试 |
| DescribeApiQpsData | 查询指定API监控数据中对QPS的统计数据 | 查看文档去调试 |
| DescribeApiTrafficControls | 查询指定分组指定环境下所有API的流控策略绑定概况 | 查看文档去调试 |
| DescribeApiTrafficData | 查询指定API监控数据中对流量的统计数据 | 查看文档去调试 |
| DescribeInstanceDropPacket | 查看专享实例一定时间内丢弃数据包数 | 查看文档去调试 |
| DescribeInstanceDropConnections | 查看专享实例一定时间内丢失的连接数 | 查看文档去调试 |
| DescribeInstanceHttpCode | 查看专享实例一定时间内请求的HTTP状态码分布 | 查看文档去调试 |
| DescribeInstanceLatency | 查看专享实例一定时间内平均延时 | 查看文档去调试 |
| DescribeInstanceNewConnections | 查看专享实例一定时间内新建连接数 | 查看文档去调试 |
| DescribeInstancePackets | 查看专享实例一定时间内流入流出数据包数 | 查看文档去调试 |
| DescribeInstanceQps | 查看专享实例一定时间内请求次数 | 查看文档去调试 |
| DescribeInstanceSlbConnect | 查看专享实例一定时间内并发连接数 | 查看文档去调试 |
| DescribeInstanceTraffic | 查看专享实例一定时间内请求和应答流量 | 查看文档去调试 |
| DescribeGroupQps | 查询指定的分组在一段时间内请求量的统计信息 | 查看文档去调试 |
| DeleteMonitorGroup | 删除API分组对应的云监控的应用分组 | 查看文档去调试 |
API管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateApi | 新建一个 API | 查看文档去调试 |
| CreateApiStageVariable | 在某运行环境下增加变量 | 查看文档去调试 |
| ImportOAS | 使用标准OAS定义导入API | 查看文档去调试 |
| ImportSwagger | 通过导入符合阿里云 Swagger 规范的文本内容创建 API | 查看文档去调试 |
| DescribeApisByBackend | 查询使用该后端服务创建的草稿态API，或已发布在某个环境上的API | 查看文档去调试 |
| DescribeApi | 查询指定API的定义 | 查看文档去调试 |
| DescribeApiMarketAttributes | 查询API上云市场属性 | 查看文档去调试 |
| DescribeApis | 查询定义中的API列表 | 查看文档去调试 |
| DescribeApiHistory | 查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义 | 查看文档去调试 |
| DescribeApisByApp | 根据APP查询关联的API列表 | 查看文档去调试 |
| DescribeAuthorizedApis | 查询指定 APP 已授权的API列表，即指定 APP 的API列表 | 查看文档去调试 |
| DescribeApiDoc | 查询指定API的服务说明文档 | 查看文档去调试 |
| DescribeDeployedApi | 查询指定API在指定环境中正在运行的定义，是真正在指定环境中生效的定义，可能跟正在编辑中的定义不同 | 查看文档去调试 |
| DescribeHistoryApis | 查询API历史发布版本列表 | 查看文档去调试 |
| DescribeImportOASTask | 查询OAS批量导入API的结果 | 查看文档去调试 |
| DescribePurchasedApis | 获取在云市场购买的 API 列表 | 查看文档去调试 |
| DescribeApiHistories | 查询指定API历次历史发布的版本列表 | 查看文档去调试 |
| DescribeDeployedApis | 查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表 | 查看文档去调试 |
| DescribeMarketRemainsQuota | 给购买者查询订购关系剩余次数 | 查看文档去调试 |
| DescribeDeployApiTask | 查询发布API的异步任务的进度 | 查看文档去调试 |
| DescribeAbolishApiTask | 查询API下线任务的进度 | 查看文档去调试 |
| ModifyApiConfiguration | 本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可 | 查看文档去调试 |
| ModifyApi | 修改API的定义信息 | 查看文档去调试 |
| DeleteApi | 删除指定的API定义 | 查看文档去调试 |
| DeleteApiStageVariable | 删除指定环境的指定变量 | 查看文档去调试 |
| AbolishApi | 下线指定运行环境的指定API | 查看文档去调试 |
| DeployApi | 发布API到指定的运行环境 | 查看文档去调试 |
| BatchDeployApis | 批量发布API到预发/测试/线上环境 | 查看文档去调试 |
| BatchAbolishApis | 批量下线已经发布到环境的API | 查看文档去调试 |
| SwitchApi | 指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义 | 查看文档去调试 |
| DryRunSwagger | 使用swagger导入swagger之前先预先检查swagger的语法是否规范 | 查看文档去调试 |
应用
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateApp | 创建API网关的APP | 查看文档去调试 |
| DescribeApps | 查询应用列表，非APP拥有者会隐藏APP的信息 | 查看文档去调试 |
| DescribeAppAttributes | 查询APP列表及基本信息 | 查看文档去调试 |
| DescribeAuthorizedApps | 查询当前的应用（APP）列表 | 查看文档去调试 |
| DescribeApp | 查询可授权的 APP 列表，为开发者在操作授权时提取 APP 信息 | 查看文档去调试 |
| DescribeAppSecurity | 该密钥在调用API时要用作身份认证 | 查看文档去调试 |
| ModifyApp | 修改指定APP应用 | 查看文档去调试 |
| DeleteApp | 删除指定APP | 查看文档去调试 |
| ResetAppCode | 重置应用的AppCode。此接口每个用户每分钟只能调一次 | 查看文档去调试 |
专有网络
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeApiGroupVpcWhitelist | 查询API分组允许访问的VPC白名单 | 查看文档去调试 |
| DescribeVpcAccesses | 查询已授权的VPC列表 | 查看文档去调试 |
| DescribeUpdateVpcInfoTask | 更新VPC授权会异步更新关联的发布中的API，该API用来查询这些API的更新进度 | 查看文档去调试 |
| ValidateVpcConnectivity | 测试API网关到指定VPC授权中指定实例的指定端口的网络连通性 | 查看文档去调试 |
| ModifyVpcAccessAndUpdateApis | 修改VPC授权信息并更新关联的API元信息 | 查看文档去调试 |
| ModifyApiGroupVpcWhitelist | 修改API分组VPC专有网络白名单 | 查看文档去调试 |
| SetVpcAccess | 创建VPC授权，开通反向访问 | 查看文档去调试 |
| RemoveVpcAccess | 仅删除VPC授权，不做下线关联API的修改 | 查看文档去调试 |
| RemoveVpcAccessAndAbolishApis | 删除VPC授权并下线关联的已经发布在线上的API | 查看文档去调试 |
访问控制策略
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateAccessControlList | 本功能为API网关专享实例提供实例级别的访问控制能力； 创建访问控制策略，每个用户每个region下只允许创建5个访问控制策略 | 查看文档去调试 |
| DescribeAccessControlListAttribute | 本功能为API网关专享实例提供实例级别的访问控制能力； 查看访问控制策略详情 | 查看文档去调试 |
| DescribeAccessControlLists | 本功能为API网关专享实例提供实例级别的访问控制能力； 查看访问控制策略列表 | 查看文档去调试 |
| SetAccessControlListAttribute | 本功能为API网关专享实例提供实例级别的访问控制能力； 修改访问控制策略名称 | 查看文档去调试 |
| AddAccessControlListEntry | 本功能为API网关专享实例提供实例级别的访问控制能力； 在实例的访问控制策略中添加IP条目 | 查看文档去调试 |
| RemoveAccessControlListEntry | 本功能为API网关专享实例提供实例级别的访问控制能力； 在实例的访问控制策略中删除IP条目 | 查看文档去调试 |
| DeleteAccessControlList | 本功能为API网关专享实例提供实例级别的访问控制能力； 删除访问控制策略 | 查看文档去调试 |
插件
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreatePlugin | 新建API网关插件 | 查看文档去调试 |
| DescribePluginApis | 查询插件绑定的API列表 | 查看文档去调试 |
| DescribePluginsByApi | 查询指定环境指定API上绑定的一组插件，该API在该环境必须是运行中状态 | 查看文档去调试 |
| DescribePluginSchemas | 描述API网关支持的插件模式 | 查看文档去调试 |
| DescribePluginTemplates | 获取插件模板列表 | 查看文档去调试 |
| DescribePlugins | 查询插件列表及详情 | 查看文档去调试 |
| AttachPlugin | 将API和插件建立绑定关系 | 查看文档去调试 |
| ModifyPlugin | 修改插件信息 | 查看文档去调试 |
| DetachPlugin | 解绑API绑定的插件 | 查看文档去调试 |
| DeletePlugin | 删除某个插件 | 查看文档去调试 |
| DetachGroupPlugin | 解绑分组插件 | 查看文档去调试 |
| AttachGroupPlugin | 分组绑定插件 | 查看文档去调试 |
| DescribePluginsByGroup | 查询API分组绑定的插件 | 查看文档去调试 |
| DescribePluginGroups | 根据插件查询绑定的分组列表 | 查看文档去调试 |
自定义数据集
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateDataset | 创建用户自定义数据集 | 查看文档去调试 |
| CreateDatasetItem | 创建用户自定义数据集的数据条目 | 查看文档去调试 |
| DescribeDatasetInfo | 查询单个数据集信息 | 查看文档去调试 |
| DescribeDatasetList | 查询用户自定义数据集列表 | 查看文档去调试 |
| DescribeDatasetItemInfo | 查询用户自定义数据集的数据集条目信息 | 查看文档去调试 |
| DescribeDatasetItemList | 查询用户自定义数据集的数据条目列表 | 查看文档去调试 |
| ModifyDataset | 修改用户自定义数据集名称 | 查看文档去调试 |
| ModifyDatasetItem | 修改用户自定义数据集的数据条目的超时时间和描述 | 查看文档去调试 |
| DeleteDataset | 删除用户自定义数据集 | 查看文档去调试 |
| DeleteDatasetItem | 删除用户自定义数据集的数据条目 | 查看文档去调试 |
后端
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateBackend | 在API网关创建后端服务 | 查看文档去调试 |
| DescribeBackendList | 查询后端服务列表，可以根据后端服务名称和后端服务类型进行过滤 | 查看文档去调试 |
| DescribeBackendInfo | 查询后端服务的信息以及在各个环境上配置的后端地址 | 查看文档去调试 |
| DescribeUpdateBackendTask | 修改后端服务在某个环境上的定义时，关联的已发布API会批量更新，该接口用来查询更新的结果 | 查看文档去调试 |
| ModifyBackend | 修改后端服务的基本信息如名称，描述，后端服务类型一经创建无法修改 | 查看文档去调试 |
| DeleteBackend | 删除后端服务 | 查看文档去调试 |
签名插件（经典网络实例）
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateSignature | 创建后端签名密钥 | 查看文档去调试 |
| DescribeSignatures | 查询API网关后端签名密钥列表 | 查看文档去调试 |
| DescribeApisBySignature | 查询指定签名密钥所绑定的API列表信息 | 查看文档去调试 |
| DescribeApiSignatures | 查询指定分组指定环境下，所有API的签名密钥绑定情况 | 查看文档去调试 |
| DescribeSignaturesByApi | 查询指定API已绑定的后端签名密钥 | 查看文档去调试 |
| ModifySignature | 修改API网关后端签名密钥 | 查看文档去调试 |
| SetSignatureApis | 添加指定签名密钥与API的绑定 | 查看文档去调试 |
| DeleteSignature | 删除API网关后端签名密钥 | 查看文档去调试 |
| RemoveSignatureApis | 解除API与后端签名密钥的绑定关系 | 查看文档去调试 |
流控插件（经典网络实例）
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| AddTrafficSpecialControl | 在指定流控策略下添加用户自定义特殊流控策略 | 查看文档去调试 |
| CreateTrafficControl | 创建用户自定义的流控策略 | 查看文档去调试 |
| DescribeTrafficControls | 查询用户自定义的流控策略列表及详情信息，支持条件查询 | 查看文档去调试 |
| DescribeTrafficControlsByApi | 查询指定API已绑定的流控策略 | 查看文档去调试 |
| DescribeApisByTrafficControl | 查询指定流控策略下已绑定的API列表信息 | 查看文档去调试 |
| ModifyTrafficControl | 修改用户自定义的流控策略设置 | 查看文档去调试 |
| SetTrafficControlApis | 添加指定流控策略与API的绑定 | 查看文档去调试 |
| DeleteAllTrafficSpecialControl | 删除指定流控策略下用户所有自定义的特殊流控策略 | 查看文档去调试 |
| DeleteTrafficControl | 删除指定的用户自定义流控策略，以及该策略包含的特殊流控策略 | 查看文档去调试 |
| DeleteTrafficSpecialControl | 删除指定的用户自定义特殊流控策略 | 查看文档去调试 |
| RemoveTrafficControlApis | 解除API与流控策略的绑定关系 | 查看文档去调试 |
访问控制插件（经典网络实例）
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| AddIpControlPolicyItem | 向某个已存在的IP访问控制增加一条策略 | 查看文档去调试 |
| CreateIpControl | 在某个地域下新增IP访问控制 | 查看文档去调试 |
| DescribeApiIpControls | 查询指定分组指定环境下，所有API的IP访问控制绑定情况 | 查看文档去调试 |
| DescribeIpControlPolicyItems | 分页查询某IP访问控制下的策略列表 | 查看文档去调试 |
| DescribeIpControls | 分页查询用户自定义的IP访问控制列表 | 查看文档去调试 |
| DescribeApisByIpControl | 查询指定IP访问控制所绑定的API列表信息 | 查看文档去调试 |
| ModifyIpControl | 修改某个已存在的IP访问控制 | 查看文档去调试 |
| ModifyIpControlPolicyItem | 修改某个IP访问控制下的某条策略 | 查看文档去调试 |
| SetIpControlApis | 添加指定IP访问控制与API的绑定关系 | 查看文档去调试 |
| DeleteIpControl | 删除某个已存在的IP访问控制 | 查看文档去调试 |
| RemoveIpControlApis | 解除API与IP访问控制的绑定关系 | 查看文档去调试 |
| RemoveIpControlPolicyItem | 移除某个IP访问控制下的一条或多条策略 | 查看文档去调试 |
其他
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeApisWithStageNameIntegratedByApp | 根据应用查询API列表，返回环境聚合的结果 | 查看文档去调试 |
| DescribeGroupLatency | 查询指定分组指定环境下，分组的平均延迟 | 查看文档去调试 |
| DescribeGroupTraffic | 查询指定api分组的流量 | 查看文档去调试 |
| ModifyApiGroupInstance | 修改api分组所属的实例 | 查看文档去调试 |
| ModifyApiGroupNetworkPolicy | 修改api分组的网络 | 查看文档去调试 |
| DetachApiProduct | 解除API与API产品的绑定关系 | 查看文档去调试 |
| SetApiProductsAuthorities | 批量授权API产品给指定APP | 查看文档去调试 |
| DescribeApiProductsByApp | 根据APP查询有权限的API产品列表 | 查看文档去调试 |
| DescribeApiProductApis | 查询API产品绑定的API列表 | 查看文档去调试 |
| DescribeAppsByApiProduct | 根据API产品查询授权了的APP列表 | 查看文档去调试 |
| AttachApiProduct | 将API绑定到指定的API产品（如果指定的API产品不存在，将自动创建） | 查看文档去调试 |
| DeleteApiProduct | 删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败） | 查看文档去调试 |
| RemoveApiProductsAuthorities | 批量移除API产品对指定APP的授权 | 查看文档去调试 |
| SetAppsAuthToApiProduct | 批量授权多个APP给指定的API产品 | 查看文档去调试 |
| DescribeApisByVpcAccess | 查询指定地域内指定api的访问控制绑定情况 | 查看文档去调试 |
| DeleteAppCode | 删除指定App的AppCode | 查看文档去调试 |
| DeleteAppKey | 删除指定App的AppKey和AppSecret | 查看文档去调试 |
| CreateAppCode | 给App添加AppCode | 查看文档去调试 |
| CreateAppKey | App添加AppKey和AppSecret | 查看文档去调试 |
| DescribeInstanceClusterInfo | 查询专享实例集群信息 | 查看文档去调试 |
| DescribeInstanceClusterList | 查询专享实例集群列表 | 查看文档去调试 |
| DescribeAppSecurities | 查询App的密钥信息 | 查看文档去调试 |
| ExportOAS | 导出OAS | 查看文档去调试 |