All Products
Search

This Product

    Microservices Engine:UpdateGatewayRoute

    Document Center

    Microservices Engine:UpdateGatewayRoute

    Last Updated:Dec 19, 2025

    Updates a routing rule for a gateway.

    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

    mse:UpdateGatewayRoute

    update

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    GatewayId

    integer

    No

    The gateway ID.

    501
    Name deprecated

    string

    No

    The route name.

    route-web
    RouteOrder

    integer

    No

    The sequence number of the route.

    1
    Predicates

    array

    Yes

    The route matching conditions.

    PathPredicates

    object

    Yes

    The path matching.

    Path

    string

    No

    The route path.

    /test
    Type

    string

    No

    The matching type.

    PRE
    IgnoreCase

    boolean

    No

    Specifies whether to ignore case sensitivity.

    true
    MethodPredicates

    array

    No

    The information about method matching.

    string

    No

    The method.

    GET
    HeaderPredicates

    array

    No

    The information about header matching.

    object

    No

    The request header.

    Key

    string

    No

    The request header key.

    debug
    Value

    string

    No

    The corresponding value.

    on
    Type

    string

    No

    The matching type.

    PRE
    QueryPredicates

    array

    No

    The information about parameter matching.

    object

    No

    The URL parameter.

    Key

    string

    No

    The parameter name.

    userid
    Value

    string

    No

    The value.

    test
    Type

    string

    No

    The match type.

    PRE
    Services

    array

    No

    The service that you want to associate with the gateway. This parameter is required if the Route Point parameter is set to Single Service, Multiple Services, or Label routing.

    array

    No

    The list of services.

    ServiceId

    integer

    No

    The service ID.

    1
    Percent

    integer

    No

    The traffic weight of the service of a specific version, in percentage. This parameter is required if the Route Point parameter is set to Multiple Services or Label routing.

    80
    Version

    string

    No

    The service version. This parameter is required only if the Route Point parameter is set to Label routing.

    v1
    Name

    string

    No

    The name.

    web
    SourceType

    string

    No

    The type of the source.

    MSE
    Namespace

    string

    No

    The namespace to which the service belongs.

    default
    GroupName

    string

    No

    The name of the group to which the service belongs.

    test
    AgreementType

    string

    No

    The Protocol Type.

    DUBBO

    HttpDubboTranscoder

    object

    No

    The Dubbo protocol converter.

    DubboServiceName

    string

    No

    The Dubbo service name.

    org.apache.dubbo.samples.basic.api.DemoService
    DubboServiceVersion

    string

    No

    The Dubbo service version.

    0.0.0
    DubboServiceGroup

    string

    No

    The Dubbo service group.

    service name
    MothedMapList

    array

    No

    The Dubbo forwarding rules.

    array

    No

    The method mapping object.

    DubboMothedName

    string

    No

    The Dubbo method name.

    sayHello
    HttpMothed

    string

    No

    The HTTP method.

    Note

    Supported HTTP method parameter values.

    • ALL_GET.

    • ALL_POST.

    • ALL_PUT.

    • ALL_DELETE.

    • ALL_PATCH.

    ALL_GET
    Mothedpath

    string

    No

    The path that is used to match a method.

    /mytestzbk/sayhello

    PassThroughAllHeaders

    string

    No

    The pass-through type of the header.

    Note

    Enumeration values for pass-through types.

    • PASS_ALL: All headers are passed through.

    • PASS_NOT: All headers are not passed through.

    • PASS_ASSIGN: Specified headers are passed through.

    PASS_NOT

    PassThroughList

    array

    No

    The headers that are passed through.

    string

    No

    The header value that is passed through.

    x-forward

    ParamMapsList

    array

    No

    The information about parameter mappings.

    object

    No

    The parameter mapping object.

    ExtractKeySpec

    string

    No

    The input parameter position.

    Note

    Enumeration values for input parameter positions.

    • Request parameter: ALL_QUERY_PARAMETER

    • Request header: ALL_HEADER

    • URI of the request: ALL_PATH

    • Request body: ALL_BODY

    ALL_QUERY_PARAMETER

    ExtractKey

    string

    No

    The key of the input parameter that is extracted.

    name
    MappingType

    string

    No

    The type of the backend service parameter.

    java.lang.String
    ServicePort

    integer

    No

    The Dubbo port number.

    20880
    Id

    integer

    No

    The route ID.

    139
    DestinationType

    string

    No

    The destination service type.

    Mock
    DirectResponseJSON

    object

    No

    The Mock content.

    Code

    integer

    No

    The Mock return code.

    200
    Body

    string

    No

    The return value.

    hello
    GatewayUniqueId

    string

    Yes

    The unique ID of the gateway.

    gw-86575c0bc9f04ecfbacb92b8e392a2c4
    DomainIdListJSON

    string

    Yes

    The associated domain name.

    [90]
    RedirectJSON

    object

    No

    The redirection.

    Code

    integer

    No

    The status code.

    302
    Host

    string

    No

    The hostname to be redirected to.

    test.com
    Path

    string

    No

    The path to be redirected to.

    /test
    EnableWaf deprecated

    boolean

    No

    Deprecated. Use UpdateGatewayRouteWafStatus to update the WAF status of a route.

    false
    Fallback

    boolean

    No

    Indicates whether to enable the Fallback service.

    true
    FallbackServices

    array

    No

    The Fallback services.

    object

    No

    The data object.

    ServiceId

    integer

    No

    The service ID.

    1
    Percent

    integer

    No

    The weight in the form of a percentage value.

    80
    Version

    string

    No

    The version of the service.

    v1
    Name

    string

    No

    The name.

    name
    SourceType

    string

    No

    The type of the source.

    MSE
    Namespace

    string

    No

    The namespace in which the service resides.

    Namespace

    GroupName

    string

    No

    The name of the group to which the service belongs.

    test
    AgreementType

    string

    No

    The Protocol Type.

    DUBBO

    ServicePort

    integer

    No

    The service port number.

    8848
    Description

    string

    No

    The route description

    a route for xxx
    AcceptLanguage

    string

    No

    The language of the response. Valid values:

    • zh: Chinese

    • en: English

    zh

    Response elements

    Parameter

    Type

    Description

    Example

    object

    Data structure

    RequestId

    string

    The request ID

    73785414-2C5B-5E28-BD91-B2C742269C48
    HttpStatusCode

    integer

    The HTTP status code.

    200
    Message

    string

    The message returned.

    The request is successfully processed.

    Code

    integer

    The status code

    200
    Success

    boolean

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.

    • false: The call failed.

    true
    Data

    integer

    The data.

    337
    ErrorCode

    string

    The error code.

    NoPermission

    Examples

    Success response

    JSON format

    {
  "RequestId": "73785414-2C5B-5E28-BD91-B2C742269C48",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": 337,
  "ErrorCode": "NoPermission"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalRequest Invalid request:%s Invalid request: %s
    400 InvalidParameter Parameter error:%s Request parameter error: %s
    500 InternalError Console error. Try again later:%s Console error. Try again later: %s
    403 NoPermission You are not authorized to perform this operation:%s You do not have the permission to use this interface:%s
    404 NotFound Not found:%s The resource does not exist:%s

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.