更新时间:2024-07-19 GMT+08:00

API概览

API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。

表1 专享版API概览

类型

说明

API分组管理

包括API分组的创建、修改、删除、查询详情和列表等接口。

环境管理

包括环境的创建、修改、删除和查询列表等接口。

环境变量管理

包括环境变量的新建、修改、删除、查询详情和列表等接口。

流控策略管理

包括流控策略的创建、修改、删除、查看详情和列表等接口。

API管理

包括API的创建、修改、删除、发布或下线、查询、调试、切换版本、校验API定义等接口。

签名密钥管理

包括签名密钥的创建、修改、删除和查询等接口。

签名密钥绑定关系管理

包括签名密钥的绑定、解绑、查询API绑定的密钥列表、查看密钥绑定/未绑定的API列表。

API绑定流控策略

包括绑定、解绑、批量解绑API与流控策略的关系,查看流程策略绑定/未绑定的API列表,查看API绑定的流控策略列表。

设置特殊流控

包括创建、修改、删除特殊流控策略,查看特殊设置列表。

APP授权管理

包括APP授权、解除授权,查看APP已绑定/未绑定的API列表,查看API已绑定的APP列表。

概要查询

包括查询API概况、API分组概况、APP概况。

域名管理

包括域名的绑定、修改、解绑。域名证书的绑定、删除、查看。

ACL策略管理

包括ACL策略的创建、修改、删除、批量删除,查看ACL策略详情、查询ACL策略列表。

API绑定ACL策略

包括将API与ACL策略绑定、解绑、批量解绑,查看ACL策略绑定/未绑定的API列表,查看API绑定的ACL策略列表。

自定义认证管理

包括自定义认证的创建、修改、删除,查看自定义认证详情,查询自定义认证列表。

OpenAPI接口

包括API的导出、导入。

VPC通道管理

包括:

  • VPC通道的创建、更新、删除、查看,查询VPC通道列表。
  • 后端实例的添加、查看、删除。
  • 后端服务器状态的批量修改。
  • VPC通过健康检查的修改。
  • 后端服务器组的添加、更新、删除、查看,查询VPC通道后端服务器组列表。

监控信息查询

包括查询最近一段时间的API统计信息,查询最近一小时内的分组统计信息。

分组自定义响应管理

包括分组自定义响应的创建、查询、修改、删除,查询分组自定义响应列表,查看、修改分组下指定错误类型的自定义响应,删除分组指定错误类型的自定义响应配置。

标签管理

包括标签列表的查询。

实例特性管理

包括实例特性的配置,查看实例特性列表。

配置管理

包括查看某实例的租户配置列表,查询租户实例配置列表。

实例管理

包括:

  • 实例的创建、更新、查看、删除,查看实例创建进度,查询实例列表。
  • EIP的绑定、解绑。
  • 实例公网出口的开启、关闭,更新实例公网出口带宽。
  • 查看可用区信息。
  • 实例的规格变更。
  • 查看实例约束信息。

实例终端节点管理

包括:

  • 查询实例终端节点连接列表。
  • 查询实例终端节点服务的白名单列表。
  • 接受/拒绝终端节点连接。
  • 批量添加/删除实例终端节点白名单。

实例标签管理

包括实例标签的添加、删除和查询。

微服务中心管理

包括导入微服务。

SSL证书管理

包括:

  • 证书的创建、删除、修改、查看,获取SSL证书列表。
  • 域名绑定/解绑SSL证书。
  • SSL证书绑定/解绑域名
  • 获取SSL证书已绑定的域名列表。

插件管理

包括:

  • 插件的创建、修改、删除、查看,查询插件列表。
  • 插件绑定/解绑API。
  • API绑定/解绑插件。
  • 查询插件/API下绑定的API/插件。
  • 查询可绑定当前插件的API,查询可绑定当前API的插件。

凭据管理

包括:

  • APP的创建、修改、删除、校验,重置密钥,查看APP详情、查询APP列表。
  • APP Code的创建、自动生成、删除,查看APP Code详情、查询APP Code列表。
  • 查询凭据关联的凭据配额。
  • 设置/删除APP的访问控制,查看APP的访问控制详情。

凭据配额管理

包括:

  • 凭据配额的创建、修改、删除。
  • 获取凭据配额详情和凭据配额列表。
  • 凭据配额绑定/解绑凭据列表 。
  • 查询凭据配额已绑定的凭据和未绑定的凭据。

异步任务管理

包括:

  • API的异步导入/导出。
  • 获取异步任务结果。

编排规则管理

包括:

  • 编排规则的创建、查看、更新、删除,查询编排规则详情。
  • 查询编排规则绑定的API。

实例自定义入方向端口管理

包括:

  • 新增/删除实例的自定义入方向端口。
  • 查询实例的自定义入方向端口。
  • 查询实例的自定义入方向端口绑定的域名信息。
表2 共享版API概览(仅存量用户使用)

类型

说明

API分组管理

包括API分组的创建、修改、删除和查询等接口。

API管理

包括API的创建、修改、删除、发布、下线和查询等接口。

APP管理

包括APP的创建、修改、删除、重置密钥和查询等接口。

APP授权管理

包括授权、解除授权、查询授权关系等接口。

环境管理

包括环境的创建、修改、删除和查询接口。

环境变量管理

包括环境变量的创建、删除和查询等接口。

流控策略管理

包括流控策略的创建、修改、删除和查询等接口。

API绑定流控策略

包括流控策略的查询、绑定和解除绑定等接口。

设置特殊流控

包括特殊流控的创建、修改、删除和查询接口。

ACL策略管理

包括黑白名单的创建、修改、删除和查看等接口。

API绑定ACL策略

包括查询API绑定ACL策略列表、查看ACL策略绑定/未绑定API列表和解除已绑定的API接口。

云商店订购信息查询

包括查询已购买的API分组列表、查询分组详情和API列表接口。

配置管理

包括配置对象模型和查询租户配置详情接口。

概要查询

包括概要信息的查询接口。

签名密钥管理

包括签名密钥的创建、修改、删除和查询接口。

签名密钥绑定关系管理

包括签名密钥的绑定和解除绑定接口,查询签名密钥绑定/未绑定API列表接口。

域名管理

包括域名的绑定、解绑和证书的绑定、删除接口。

VPC通道管理

包括创建VPC通道、更新VPC通道、删除VPC通道、查看VPC通道详情和列表、添加和删除云服务器、查看云服务器列表。

监控信息查询

包括API/API分组的统计信息查询接口。

OpenAPI接口

导出租户发布分组到指定环境的Swagger API。

自定义认证管理

包括自定义认证的创建、修改、删除,查看自定义认证详情,查询自定义认证列表。