本产品(
云原生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 | 资源转组 | 资源转组。 |