UpdateHttpApiRoute-阿里云帮助中心

Updates an HTTP API route.

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 : Grayscale release based on traffic ratio across multiple services 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 edition.	v1
weight	integer	No	The percentage value of the traffic.	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 description of the route.	商品中心服务路由
mcpRouteConfig	object	No
protocol	string	No
exposedUriPath	string	No
mcpStatisticsEnable	boolean	No
policyConfigs	array<object>	No
	array<object>	No
type	string	No
enable	boolean	No
aiFallbackConfig	object	No
serviceConfigs	array<object>	No
	object	No
serviceId	string	No
name	string	No
targetModelName	string	No
passThroughModelName	boolean	No
onlyRedirectUpstreamCode	boolean	No
routeEmbedded	boolean	No
aiSecurityGuardConfig	object	No
serviceAddress	string	No
checkRequest	boolean	No
checkResponse	boolean	No
checkRequestImage	boolean	No
checkResponseImage	boolean	No
requestCheckService	string	No
responseCheckService	string	No
requestImageCheckService	string	No
responseImageCheckService	string	No
riskAlertLevel	string	No
riskConfig	array<object>	No
	array<object>	No
type	string	No
level	string	No
consumerRules	object	No
pattern	string	No	The loop rule.
matchType	string	No
bufferLimit	integer	No
pluginStatus	object	No
errorLogs	object	No
	string	No
serviceHealthy	boolean	No
pluginId	string	No
consumerRequestCheckService	array<object>	No
	object	No
name	string	No
requestCheckService	string	No
requestImageCheckService	string	No
matchType	string	No
modalityType	string	No
consumerResponseCheckService	array<object>	No
	object	No
name	string	No
responseCheckService	string	No
responseImageCheckService	string	No
matchType	string	No
modalityType	string	No
consumerRiskLevel	array<object>	No
	object	No
name	string	No
matchType	string	No
type	string	No
level	string	No
aiTokenRateLimitConfig	object	No
rules	array<object>	No
	object	No
limitType	string	No
matchKey	string	No
matchType	string	No
matchValue	string	No
limitMode	string	No
limitValue	integer	No
enableGlobalRules	boolean	No
globalRules	array<object>	No
	object	No
limitType	string	No
matchKey	string	No
matchType	string	No
matchValue	string	No
limitMode	string	No
limitValue	integer	No
redisConfig	object	No
host	string	No
port	integer	No
username	string	No
password	string	No
timeout	integer	No
databaseNumber	integer	No
pluginStatus	object	No
errorLogs	object	No
	string	No
serviceHealthy	boolean	No
pluginId	string	No
aiCacheConfig	object	No
cacheTTL	integer	No
redisConfig	object	No
host	string	No
port	integer	No
username	string	No
password	string	No
timeout	integer	No
databaseNumber	integer	No
vectorConfig	object	No
type	string	No
serviceHost	string	No
apiKey	string	No	The API key.
timeout	integer	No		6000
collectionId	string	No
threshold	number	No
embeddingConfig	object	No
type	string	No
serviceId	string	No
timeout	integer	No
modelName	string	No
cacheKeyStrategy	string	No
cacheMode	string	No
pluginStatus	object	No
errorLogs	object	No
	string	No
serviceHealthy	boolean	No
pluginId	string	No
aiNetworkSearchConfig	object	No
needReference	boolean	No
referenceFormat	string	No
referenceLocation	string	No
defaultLang	string	No
defaultEnable	boolean	No
searchFrom	array<object>	No
	array<object>	No
type	string	No
apiKey	string	No
count	integer	No
start	integer	No
timeoutMillisecond	integer	No
optionArgs	object	No
	string	No
endpoint	string	No
contentMode	string	No
industry	string	No
timeRange	string	No
searchEngineConfig	object	No	Search engine configuration
type	string	No
apiKey	string	No
count	integer	No
start	integer	No
timeoutMillisecond	integer	No
optionArgs	object	No
	string	No
endpoint	string	No
contentMode	string	No
industry	string	No
timeRange	string	No
searchRewrite	object	No
enable	boolean	No
serviceId	string	No
modelName	string	No
timeoutMillisecond	integer	No
maxCount	integer	No
pluginStatus	object	No
errorLogs	object	No
	string	No
serviceHealthy	boolean	No
pluginId	string	No
aiToolSelectionConfig	object	No
enableConditions	object	No
toolCountThreshold	integer	No
toolReranking	object	No
modelService	object	No
serviceId	string	No
modelName	string	No
timeoutMillisecond	integer	No
filteringMethod	string	No
topKPercent	integer	No
topNCount	integer	No
scoreThreshold	number	No
fallbackStrategy	string	No
queryRewriting	object	No
enabled	boolean	No
modelService	object	No
serviceId	string	No
modelName	string	No
timeoutMillisecond	integer	No
promptConfig	object	No
type	string	No
customPrompt	string	No
maxOutputTokens	integer	No
triggerConditions	object	No
messageCountThreshold	integer	No
contextSelection	object	No
type	string	No
value	integer	No
fallbackStrategy	string	No
pluginStatus	object	No
errorLogs	object	No
	string	No
serviceHealthy	boolean	No
pluginId	string	No
aiStatisticsConfig	object	No
logRequestContent	boolean	No
logResponseContent	boolean	No
semanticRouterConfig	object	No
timeoutMillisecond	integer	No

Response elements

Element	Type	Description	Example
	object	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.