Create & Manage HTTP API Routes via API Gateway SDK - API Gateway - Alibaba Cloud - API Gateway

Creates a route for an HTTP API.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:CreateHttpApiRoute

none

*HttpApi

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
httpApiId	string	No	The ID of the HTTP API to which the route belongs.	api-cqoob7llhtgq***

Request parameters

Parameter	Type	Required	Description	Example
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.	用户登录路由。
domainIds	array	No	The domain name IDs.
	string	No	The domain name IDs.	d-cr62ts5lhtglnu***
match	HttpRouteMatch	No	The route match rule.
backendConfig	object	No	The backend service configuration of the route.
scene	string	No	The backend service scenario. Valid values: SingleService: single service. MultiServiceByRatio: multiple services with ratio-based canary release. Mock: mock service. Redirect: redirect service. Valid values: SingleService : Single service. MultiServiceByRatio : Multiple services with ratio-based canary release. Redirect : Redirect MultiServiceByTag : Multiple services by tag. Mock : Mock	SingleService
services	array<object>	No	The list of backend services.
	object	No	The backend service.
serviceId	string	No	The service ID.	svc-crbgq0dlhtgr***
protocol	string	No	The service protocol. Valid values: HTTP. HTTPS. Valid values: HTTPS : HTTPS HTTP : HTTP	HTTP
port	integer	No	The service port. Do not specify this parameter for dynamic ports.	8080
weight	integer	No	The percentage value of the traffic ratio.	49
version	string	No	The service version. This parameter is valid only in the tag-based scenario.	v1
deployConfigs	array	No	The API deployment configurations.
	HttpApiDeployConfig	No	The API deployment configurations.
mcpRouteConfig	object	No	The MCP route configuration.
protocol	string	No	The service protocol. Valid values: TCP. HTTP. DUBBO.	HTTP,HTTPS
exposedUriPath	string	No	The exposed URI path.	/v1/chat/completions
mcpStatisticsEnable	boolean	No	Specifies whether to enable MCP observability. Default value: false.	false
policyConfigs	array	No	The policy type.
	HttpApiPolicyConfigs	No	The policy type.

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.