All Products
Search
Document Center

API Gateway:CreateHttpApiRoute

Last Updated:Feb 05, 2026
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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:CreateHttpApiRoutenone
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
httpApiIdstringNo

The HTTP API ID.

api-cqoob7llhtgq***
bodyobjectNo

The request body.

environmentIdstringNo

The environment ID.

env-cpqnr6tlhtgubcv***
namestringNo

The route name.

login
descriptionstringNo

The route description.

User logon route
domainIdsarrayNo

The list of domain IDs.

stringNo

The domain ID.

d-cr62ts5lhtglnu***
matchHttpRouteMatchNo

The route match rule.

backendConfigobjectNo

The backend service configurations for the route.

scenestringNo

The backend service scenario. Valid values:

  • SingleService
  • MultiServiceByRatio
  • Mock
  • Redirect
SingleService
servicesarray<object>No

The list of backend services.

objectNo

The backend service.

serviceIdstringNo

The service ID.

svc-crbgq0dlhtgr***
protocolstringNo

The service protocol. Valid values:

  • HTTP
  • HTTPS
HTTP
portintegerNo

The service port (omit for dynamic ports).

8080
weightintegerNo

The traffic weight percentage.

49
versionstringNo

The service version (valid only in tag-based scenarios).

v1
deployConfigsarrayNo

deployConfigs

HttpApiDeployConfigNo

HttpApiDeployConfig

mcpRouteConfigobjectNo

The MCP route configuration

protocolstringNo

The MCP protocol

HTTP,HTTPS
exposedUriPathstringNo

The exposed URI path

/v1/chat/completions
mcpStatisticsEnablebooleanNo

mcpStatisticsEnable

false
policyConfigsarrayNo

The route-level policy configurations

HttpApiPolicyConfigsNo

HttpApiPolicyConfigs

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID.

3ACFC7A7-45A9-58CF-B2D5-765B60254695
codestring

The status code.

Ok
messagestring

The returned message.

success
dataobject

The response data.

routeIdstring

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 timeSummary of changesOperation
2026-01-30The internal configuration of the API is changed, but the call is not affectedView Change Details
2025-07-24The internal configuration of the API is changed, but the call is not affectedView Change Details
2025-05-29The internal configuration of the API is changed, but the call is not affectedView Change Details