CreateHttpApiRoute - API Gateway - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Creates a route for an HTTP API.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apig:CreateHttpApiRoute	none	*HttpApi `acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
httpApiId	string	No	The HTTP API ID.	api-cqoob7llhtgq***
body	object	No	The request body.
environmentId	string	No	The environment ID.	env-cpqnr6tlhtgubcv***
name	string	No	The route name.	login
description	string	No	The route description.	User logon route
domainIds	array	No	The domain name IDs.
	string	No	The domain name ID.	d-cr62ts5lhtglnu***
match	HttpRouteMatch	No	The rule for matching the route.
backendConfig	object	No	The backend service configurations of the route.
scene	string	No	The scenario of the backend service. SingleService MultiServiceByRatio Mock Redirect	SingleService
services	array<object>	No	The backend services.
	object	No	The backend service.
serviceId	string	No	The service ID.	svc-crbgq0dlhtgr***
protocol	string	No	The protocol. Valid values: HTTP HTTPS	HTTP
port	integer	No	The service port. If you want to use a dynamic port, do not pass this parameter.	8080
weight	integer	No	The percentage value of traffic.	49
version	string	No	The service version. Pass this parameter for tag-based routing.	v1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	3ACFC7A7-45A9-58CF-B2D5-765B60254695
code	string	The status code.	Ok
message	string	The returned message.	success
data	object	The response data.
routeId	string	The route ID.	hr-cr82undlhtgrlej***

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-07-24	The internal configuration of the API is changed, but the call is not affected	View Change Details
2025-05-29	The internal configuration of the API is changed, but the call is not affected	View Change Details