调用CreateHttpApiRoute接口创建HTTP API路由-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

创建HttpApi的路由。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:CreateHttpApiRoute

none

*HttpApi

acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}

无

请求语法

POST /v1/http-apis/{httpApiId}/routes HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
httpApiId	string	否	路由所属的 HTTP API ID。	api-cqoob7llhtgq***

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
environmentId	string	否	环境 ID。	env-cpqnr6tlhtgubcv***
name	string	否	路由名称。	login
description	string	否	路由描述。	用户登录路由。
domainIds	array	否	域名 ID。
	string	否	域名 ID。	d-cr62ts5lhtglnu***
match	HttpRouteMatch	否	路由 Match 规则。
backendConfig	object	否	路由的后端服务配置。
scene	string	否	后端服务场景。 SingleService：单服务。 MultiServiceByRatio：多服务按比例灰度。 Mock：Mock 服务。 Redirect：重定向服务。枚举值： SingleService : 单服务 MultiServiceByRatio : 多服务按比例灰度 Redirect : Redirect MultiServiceByTag : 多服务按标签 Mock : Mock	SingleService
services	array<object>	否	后端服务列表。
	object	否	后端服务。
serviceId	string	否	服务 ID。	svc-crbgq0dlhtgr***
protocol	string	否	服务协议： HTTP。 HTTPS。枚举值： HTTPS : HTTPS HTTP : HTTP	HTTP
port	integer	否	服务端口, 动态端口不传入。	8080
weight	integer	否	流量比例的百分比值。	49
version	string	否	服务版本，仅在按标签场景下有效。	v1
deployConfigs	array	否	API 部署配置。
	HttpApiDeployConfig	否	API 部署配置。
mcpRouteConfig	object	否	MCP 路由配置
protocol	string	否	服务协议: TCP。 HTTP。 DUBBO。	HTTP,HTTPS
exposedUriPath	string	否	暴露的 URI 路径	/v1/chat/completions
mcpStatisticsEnable	boolean	否	是否启用 MCP 可观测，默认 false	false
policyConfigs	array	否	策略类型。
	HttpApiPolicyConfigs	否	策略类型。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	3ACFC7A7-45A9-58CF-B2D5-765B60254695
code	string	响应状态码。	Ok
message	string	响应消息，	success
data	object	响应数据。
routeId	string	路由 ID。	hr-cr82undlhtgrlej***

示例

正常返回示例

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "code": "Ok",
  "message": "success",
  "data": {
    "routeId": "hr-cr82undlhtgrlej***"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。