API概览

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

API管理

API标题API概述
CreateHttpApi创建HTTP API创建一个HTTP类型的API。
UpdateHttpApi更新HTTP API更新HTTP API。
GetHttpApi获取HTTP API读取HTTP API信息。
ListHttpApis获取HTTP API列表获取HTTP API列表。
DeleteHttpApi删除HTTP API删除指定的HTTP API。

接口管理

API标题API概述
CreateHttpApiOperation创建接口为HTTP API创建接口。
GetHttpApiOperation获取接口信息获取接口信息。
UpdateHttpApiOperation更新接口更新接口。
ListHttpApiOperations获取接口列表获取接口列表。
DeleteHttpApiOperation删除接口删除指定的接口。

路由管理

API标题API概述
CreateHttpApiRoute创建HTTP API路由创建HttpApi的路由。
UpdateHttpApiRoute更新路由更新HttpApi的路由。
GetHttpApiRoute查询路由详情获取HttpApi的路由详情。
DeleteHttpApiRoute删除路由删除HttpApi的路由。

网关管理

API标题API概述
GetGateway查询网关详情获取网关的所属VPC,所属交换机, 网关入口等基本信息。
ListGateways查询网关列表查询网关列表。
AddGatewaySecurityGroupRule添加网关安全组规则授权网关访问服务的安全组。
DeleteGateway删除网关删除网关。

环境管理

API标题API概述
CreateEnvironment创建环境创建环境。
GetEnvironment查询环境查询环境。
UpdateEnvironment更新环境更新环境。
DeleteEnvironment删除环境删除环境。
ListEnvironments查询环境列表查询环境列表。

域名管理

API标题API概述
GetDomain查询域名查询域名。
CreateDomain创建域名创建域名。
ListDomains查询域名列表查询域名列表。
DeleteDomain删除域名删除域名。
UpdateDomain更新域名更新域名。

其他

API标题API概述
ImportHttpApi导入HTTP API导入HTTP API,支持将OpenAPI 2.0和 OpenAPI 3.0.x版本的定义文件导入为REST类型的API。
ChangeResourceGroup资源转组资源转组。