使用UpdateHttpApiRoute接口更新HttpApi的路由-API网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

更新HttpApi的路由。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:UpdateHttpApiRoute

none

*HttpApi

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

无

请求语法

PUT /v1/http-apis/{httpApiId}/routes/{routeId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
httpApiId	string	否	路由所属的 HTTP API ID。	api-cqoub6tlhtgvof7***
routeId	string	否	路由 ID。	hr-cr82undlhtgrl***

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
domainIds	array	否	域名 ID 列表。
	string	否	域名 ID。	d-cr62ts5lhtgln***
match	HttpRouteMatch	否	路由 Match 规则。
backendConfig	object	否	路由的后端服务配置。
scene	string	否	后端服务场景。枚举值： SingleService : 单服务 MultiServiceByRatio : 多服务按比例灰度 Redirect : Redirect Mock : Mock	SingleService
services	array<object>	否	后端服务列表。
	object	否	后端服务。
serviceId	string	否	服务 ID。	svc-cr6pk4tlhtgm58e***
protocol	string	否	服务协议： HTTP。 HTTPS。枚举值： HTTPS : HTTPS HTTP : HTTP	HTTP
version	string	否	服务版本。	v1
weight	integer	否	流量比例的百分比值。	49
port	integer	否	服务端口, 动态端口不传入。	8080
environmentId	string	否	环境 ID。	env-cquqsollhtgid***
description	string	否	路由描述。	商品中心服务路由
mcpRouteConfig	object	否
protocol	string	否
exposedUriPath	string	否
mcpStatisticsEnable	boolean	否
policyConfigs	array<object>	否
	array<object>	否
type	string	否
enable	boolean	否
aiFallbackConfig	object	否
serviceConfigs	array<object>	否
	object	否
serviceId	string	否
name	string	否
targetModelName	string	否
passThroughModelName	boolean	否
onlyRedirectUpstreamCode	boolean	否
routeEmbedded	boolean	否
aiSecurityGuardConfig	object	否
serviceAddress	string	否
checkRequest	boolean	否
checkResponse	boolean	否
checkRequestImage	boolean	否
checkResponseImage	boolean	否
requestCheckService	string	否
responseCheckService	string	否
requestImageCheckService	string	否
responseImageCheckService	string	否
riskAlertLevel	string	否
riskConfig	array<object>	否
	array<object>	否
type	string	否
level	string	否
consumerRules	object	否
pattern	string	否	循环规则。
matchType	string	否
bufferLimit	integer	否
pluginStatus	object	否
errorLogs	object	否
	string	否
serviceHealthy	boolean	否
pluginId	string	否
consumerRequestCheckService	array<object>	否
	object	否
name	string	否
requestCheckService	string	否
requestImageCheckService	string	否
matchType	string	否
modalityType	string	否
consumerResponseCheckService	array<object>	否
	object	否
name	string	否
responseCheckService	string	否
responseImageCheckService	string	否
matchType	string	否
modalityType	string	否
consumerRiskLevel	array<object>	否
	object	否
name	string	否
matchType	string	否
type	string	否
level	string	否
aiTokenRateLimitConfig	object	否
rules	array<object>	否
	object	否
limitType	string	否
matchKey	string	否
matchType	string	否
matchValue	string	否
limitMode	string	否
limitValue	integer	否
enableGlobalRules	boolean	否
globalRules	array<object>	否
	object	否
limitType	string	否
matchKey	string	否
matchType	string	否
matchValue	string	否
limitMode	string	否
limitValue	integer	否
redisConfig	object	否
host	string	否
port	integer	否
username	string	否
password	string	否
timeout	integer	否
databaseNumber	integer	否
pluginStatus	object	否
errorLogs	object	否
	string	否
serviceHealthy	boolean	否
pluginId	string	否
aiCacheConfig	object	否
cacheTTL	integer	否
redisConfig	object	否
host	string	否
port	integer	否
username	string	否
password	string	否
timeout	integer	否
databaseNumber	integer	否
vectorConfig	object	否
type	string	否
serviceHost	string	否
apiKey	string	否	apiKey
timeout	integer	否		6000
collectionId	string	否
threshold	number	否
embeddingConfig	object	否
type	string	否
serviceId	string	否
timeout	integer	否
modelName	string	否
cacheKeyStrategy	string	否
cacheMode	string	否
pluginStatus	object	否
errorLogs	object	否
	string	否
serviceHealthy	boolean	否
pluginId	string	否
aiNetworkSearchConfig	object	否
needReference	boolean	否
referenceFormat	string	否
referenceLocation	string	否
defaultLang	string	否
defaultEnable	boolean	否
searchFrom	array<object>	否
	array<object>	否
type	string	否
apiKey	string	否
count	integer	否
start	integer	否
timeoutMillisecond	integer	否
optionArgs	object	否
	string	否
endpoint	string	否
contentMode	string	否
industry	string	否
timeRange	string	否
searchEngineConfig	object	否	搜索引擎配置
type	string	否
apiKey	string	否
count	integer	否
start	integer	否
timeoutMillisecond	integer	否
optionArgs	object	否
	string	否
endpoint	string	否
contentMode	string	否
industry	string	否
timeRange	string	否
searchRewrite	object	否
enable	boolean	否
serviceId	string	否
modelName	string	否
timeoutMillisecond	integer	否
maxCount	integer	否
pluginStatus	object	否
errorLogs	object	否
	string	否
serviceHealthy	boolean	否
pluginId	string	否
aiToolSelectionConfig	object	否
enableConditions	object	否
toolCountThreshold	integer	否
toolReranking	object	否
modelService	object	否
serviceId	string	否
modelName	string	否
timeoutMillisecond	integer	否
filteringMethod	string	否
topKPercent	integer	否
topNCount	integer	否
scoreThreshold	number	否
fallbackStrategy	string	否
queryRewriting	object	否
enabled	boolean	否
modelService	object	否
serviceId	string	否
modelName	string	否
timeoutMillisecond	integer	否
promptConfig	object	否
type	string	否
customPrompt	string	否
maxOutputTokens	integer	否
triggerConditions	object	否
messageCountThreshold	integer	否
contextSelection	object	否
type	string	否
value	integer	否
fallbackStrategy	string	否
pluginStatus	object	否
errorLogs	object	否
	string	否
serviceHealthy	boolean	否
pluginId	string	否
aiStatisticsConfig	object	否
logRequestContent	boolean	否
logResponseContent	boolean	否
semanticRouterConfig	object	否
timeoutMillisecond	integer	否

返回参数

名称	类型	描述	示例值
	object	结构体
requestId	string	请求 ID。	CBEEB8C1-108E-50F0-9BEA-DED79553C309
code	string	响应状态码。	Ok
message	string	响应消息。	success

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。