Modify HTTP API Route Rules via UpdateHttpApiRoute - API Gateway - Alibaba Cloud - API Gateway

Updates a route of an HttpApi.

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:UpdateHttpApiRoute

none

*HttpApi

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

None

Request syntax

PUT /v1/http-apis/{httpApiId}/routes/{routeId} 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-cqoub6tlhtgvof7***
routeId	string	No	The route ID.	hr-cr82undlhtgrl***

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
domainIds	array	No	The list of domain name IDs.
	string	No	The domain name ID.	d-cr62ts5lhtgln***
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 : multi-service canary release by ratio. Redirect : Redirect Mock : Mock	SingleService
services	array<object>	No	The list of backend services.
	object	No	The backend service.
serviceId	string	No	The service ID.	svc-cr6pk4tlhtgm58e***
protocol	string	No	The service protocol. Valid values: HTTP HTTPS Valid values: HTTPS : HTTPS HTTP : HTTP	HTTP
version	string	No	The service version.	v1
weight	integer	No	The percentage value of the traffic ratio.	49
port	integer	No	The service port. Do not specify this parameter for dynamic ports.	8080
environmentId	string	No	The environment ID.	env-cquqsollhtgid***
description	string	No	The route description.	商品中心服务路由
mcpRouteConfig	object	No	The MCP route configuration.
protocol	string	No	The MCP protocol.	SSE
exposedUriPath	string	No	The exposed URI path.	/mcp/chat
mcpStatisticsEnable	boolean	No	Specifies whether to enable MCP statistics.	true
policyConfigs	array	No	The route-level policy configurations.
	HttpApiPolicyConfigs	No	object

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The request ID.	CBEEB8C1-108E-50F0-9BEA-DED79553C309
code	string	The response status code.	Ok
message	string	The response message.	success

Examples

Success response

JSON format

{
  "requestId": "CBEEB8C1-108E-50F0-9BEA-DED79553C309",
  "code": "Ok",
  "message": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.