更新网关路由。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mse:UpdateGatewayRoute | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GatewayId | long | 否 | 网关 ID。 | 501 |
Namedeprecated | string | 否 | 路由名称。 | route-web |
| RouteOrder | integer | 否 | 路由顺序。 | 1 |
| Predicates | object | 是 | 路由匹配条件。 | |
| PathPredicates | object | 是 | Path 匹配。 | |
| Path | string | 否 | 路由 Path 路径。 | /test |
| Type | string | 否 | 匹配类型。 | PRE |
| IgnoreCase | boolean | 否 | 忽略大小写。 | true |
| MethodPredicates | array | 否 | 方法匹配。 | |
| string | 否 | 具体方法。 | GET | |
| HeaderPredicates | array<object> | 否 | 请求头匹配。 | |
| object | 否 | 请求头。 | ||
| Key | string | 否 | 请求头 Key。 | debug |
| Value | string | 否 | 对应的 Value。 | on |
| Type | string | 否 | 匹配类型。 | PRE |
| QueryPredicates | array<object> | 否 | 参数匹配。 | |
| object | 否 | URL 参数。 | ||
| Key | string | 否 | 参数名。 | userid |
| Value | string | 否 | 匹配值。 | test |
| Type | string | 否 | 匹配类型。 | PRE |
| Services | array<object> | 否 | 目标服务（路由指向为单服务、多服务、标签路由时填写）。 | |
| object | 否 | 服务列表。 | ||
| ServiceId | long | 否 | 服务 ID。 | 1 |
| Percent | integer | 否 | 当前服务/服务版本分流百分比（只在使用多服务、标签路由时填写）。 | 80 |
| Version | string | 否 | 服务版本（只在使用标签路由时填写）。 | v1 |
| Name | string | 否 | 名称。 | web |
| SourceType | string | 否 | 来源类型。 | MSE |
| Namespace | string | 否 | 服务所在命名空间。 | default |
| GroupName | string | 否 | 服务分组名称。 | test |
| AgreementType | string | 否 | 协议类型。 | DUBBO |
| HttpDubboTranscoder | object | 否 | Dubbo 协议转换体。 | |
| DubboServiceName | string | 否 | Dubbo 服务名称。 | org.apache.dubbo.samples.basic.api.DemoService |
| DubboServiceVersion | string | 否 | Dubbot 服务版本。 | 0.0.0 |
| DubboServiceGroup | string | 否 | Dubbo 服务组。 | service name |
| MothedMapList | array<object> | 否 | Dubbo 转发规则列表。 | |
| MothedMapList | object | 否 | 方法映射体。 | |
| DubboMothedName | string | 否 | Dubbo 方法名。 | sayHello |
| HttpMothed | string | 否 | Http 方法。 说明
支持 http 方法参数值。
| ALL_GET |
| Mothedpath | string | 否 | 方法匹配路径。 | /mytestzbk/sayhello |
| PassThroughAllHeaders | string | 否 | Header 透传类型。 说明
透传类型枚举值。
| PASS_NOT |
| PassThroughList | array | 否 | 指定透传 Header 列表。 | |
| PossThroughList | string | 否 | 指定 Header 透传值。 | x-forward |
| ParamMapsList | array<object> | 否 | 参数映射列表。 | |
| ParamMapsList | object | 否 | 参数映射体。 | |
| ExtractKeySpec | string | 否 | 入参位置。 说明
入参位置枚举值。
ALL_QUERY_PARAMETERALL_HEADERALL_PATHALL_BODY | ALL_QUERY_PARAMETER |
| ExtractKey | string | 否 | 入参位提取 Key。 | name |
| MappingType | string | 否 | 后端参数类型。 | java.lang.String |
| ServicePort | integer | 否 | Dubbo 端口。 | 20880 |
| Id | long | 否 | 路由 ID。 | 139 |
| DestinationType | string | 否 | 目标服务类型。 | Mock |
| DirectResponseJSON | object | 否 | Mock 内容。 | |
| Code | long | 否 | Mock 返回码。 | 200 |
| Body | string | 否 | Mock 返回值。 | hello |
| GatewayUniqueId | string | 是 | 网关唯一标识 ID。 | gw-86575c0bc9f04ecfbacb92b8e392a2c4 |
| DomainIdListJSON | string | 是 | 关联域名。 | [90] |
| RedirectJSON | object | 否 | 重定向。 | |
| Code | integer | 否 | 状态码。 | 302 |
| Host | string | 否 | 重定向主机名。 | test.com |
| Path | string | 否 | 重定向路径。 | /test |
| EnableWaf | boolean | 否 | 是否开启 Waf。 | false |
| Fallback | boolean | 否 | 是否开启 Fallback 服务。 | true |
| FallbackServices | array<object> | 否 | Fallback 服务。 | |
| object | 否 | 数据对象。 | ||
| ServiceId | long | 否 | 服务 ID。 | 1 |
| Percent | integer | 否 | 权重百分比。 | 80 |
| Version | string | 否 | 服务版本。 | v1 |
| Name | string | 否 | 名称。 | name |
| SourceType | string | 否 | 来源类型。 | MSE |
| Namespace | string | 否 | 服务所在命名空间。 | Namespace |
| GroupName | string | 否 | 服务分组名称。 | test |
| AgreementType | string | 否 | 协议类型。 | DUBBO |
| ServicePort | integer | 否 | 服务端口。 | 8848 |
| Description | string | 否 | 路由描述 | a route for xxx |
| AcceptLanguage | string | 否 | 返回信息的语言类型：
| zh |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "73785414-2C5B-5E28-BD91-B2C742269C48",
"HttpStatusCode": 200,
"Message": "请求处理成功",
"Code": 200,
"Success": true,
"Data": 337,
"ErrorCode": "NoPermission"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | 非法请求： %s |
| 400 | InvalidParameter | Parameter error:%s | 请求参数错误：%s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口：%s |
| 404 | NotFound | Not found:%s | 资源不存在：%s |
| 500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试：%s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-18 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-04-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-07-28 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-02-18 | 新增 OpenAPI | 查看变更详情 |