All Products
Search

This Product

    Serverless App Engine:CreateOrUpdateSwimmingLane

    Document Center

    Serverless App Engine:CreateOrUpdateSwimmingLane

    Last Updated:Apr 22, 2026

    Create or update a swimlane.

    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

    sae:CreateOrUpdateSwimmingLane

    create

    *All Resource

    *

    		 None None

    Request syntax

    POST /pop/v1/cas/gray/createOrUpdateSwimmingLane HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    LaneId

    integer

    No

    The ID of the swimlane.

    13857
    LaneName

    string

    No

    The name of the swimlane.

    test
    LaneTag

    string

    No

    The tag of the swimlane.

    g1
    GroupId

    integer

    No

    The ID of the swimlane group.

    b2a8a925-477a-eswa-b823-d5e22500****
    NamespaceId

    string

    No

    The ID of the namespace.

    cn-beijing:test
    CanaryModel

    integer

    No

    The end-to-end canary release mode.

    • 0: content-based routing

    • 1: percentage-based routing

    0
    Enable

    boolean

    No

    The status of the swimlane.

    • true: enabled

    • false: disabled

    true
    AppEntryRule

    object

    No

    The configuration of the gateway route.

    Note

    This parameter is required if the gateway entry application for the swimlane group is a Java application.

    Paths

    array

    No

    The request paths to match.

    string

    No

    The request path.

    /A
    Percentage

    integer

    No

    The traffic percentage for percentage-based routing. Valid values: 0 to 100.

    50
    ConditionJoiner

    string

    No

    The logical operator used to combine conditions.

    • AND: All conditions must be met.

    • OR: At least one of the conditions must be met.

    AND
    Conditions

    array<object>

    No

    The match conditions.

    object

    No

    A match condition.

    Type

    string

    No

    The type of the request attribute to match.

    • header: A request header.

    • param: A request parameter.

    • cookie: A request cookie.

    Header
    Name

    string

    No

    The name of the header, parameter, or cookie.

    t
    Condition

    string

    No

    The matching rule.

    • ==: Exact match. The attribute's value must be identical to the value specified.

    • !=: Negated exact match. The attribute's value must not be identical to the value specified.

    • in: Inclusion match. The attribute's value must be present in the specified comma-separated list of values.

    • percentage: Percentage-based match. The expression hash(get(key)) % 100 < value must be true.

    • regex: Regular expression match. The attribute's value must match the specified regular expression.

    ==
    Value

    string

    No

    The value to match against the request attribute.

    g1
    IndependentPercentageEnable

    boolean

    No

    Specifies whether to enable percentage-based routing.

    • true: Enables percentage-based routing. You must also configure the PercentageByPath parameter.

    • false: Disables percentage-based routing.

    true
    PercentageByPath

    object

    No

    An object that maps request paths to traffic percentages.

    integer

    No

    The traffic percentage for the configured path. Valid values: 1 to 100.

    50
    MseGatewayEntryRule

    object

    No

    Configuration for the MSE gateway route.

    Note

    This parameter is required if the EntryAppType parameter is set to apig or mse-gw.

    RouteIds

    array

    No

    The route IDs.

    integer

    No

    The ID of the gateway route. You can call the ListGatewayRoute operation to obtain the ID.

    78830
    Percentage

    integer

    No

    The traffic mirroring percentage. Valid values: 0 to 100.

    100
    ConditionJoiner

    string

    No

    The logical operator used to combine conditions.

    • AND: All conditions must be met.

    • OR: At least one of the conditions must be met.

    AND
    Conditions

    array<object>

    No

    The match conditions.

    object

    No

    A match condition.

    Type

    string

    No

    The type of the request attribute to match.

    • header: A request header.

    • param: A request parameter.

    • cookie: A request cookie.

    header

    Name

    string

    No

    The name of the header, parameter, or cookie.

    test
    Condition

    string

    No

    The matching rule.

    • ==: Exact match. The attribute's value must be identical to the value specified.

    • !=: Negated exact match. The attribute's value must not be identical to the value specified.

    • in: Inclusion match. The attribute's value must be present in the specified comma-separated list of values.

    • percentage: Percentage-based match. The expression hash(get(key)) % 100 < value must be true.

    • regex: Regular expression match. The attribute's value must match the specified regular expression.

    ==
    Value

    string

    No

    The value to match against the request attribute.

    g1
    IndependentPercentageEnable

    boolean

    No

    Specifies whether to enable percentage-based routing.

    • true: Enables percentage-based routing. You must also configure the PercentageByRoute parameter.

    • false: Disables percentage-based routing.

    true
    PercentageByRoute

    object

    No

    An object that maps route IDs to traffic percentages.

    integer

    No

    The traffic percentage for the configured route. Valid values: 1 to 100.

    100

    Response elements

    Element

    Type

    Description

    Example

    object

    The result of creating or updating the swimming lane.

    RequestId

    string

    The request ID.

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    The response message. Valid values:

    • If the request is successful, success is returned.

    • If the request fails, an error message is returned.

    success
    TraceId

    string

    The request trace ID. You can use this ID to query the details of a request.

    0a98a02315955564772843261e****
    Data

    object

    The returned data.

    LaneId

    integer

    The ID of the swimlane.

    22318
    ErrorCode

    string

    The error code.

    • This parameter is not returned if the request is successful.

    • For more information, see the "Error codes" section in this topic.

    Code

    string

    The HTTP status code or an error code of Platform as a Service (PaaS). Valid values:

    • 2xx: The request is successful.

    • 3xx: The request is redirected.

    • 4xx: A request error occurs.

    • 5xx: A server error occurs.

    200
    Success

    boolean

    Indicates whether the swimlane was created or updated. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "LaneId": 22318
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.NotEmpty You must specify the parameter %s.
    400 InvalidParameter.Obviously The specified parameter is invalid {%s}.
    400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s
    400 MseGatewayRule.CreateFailed Create MSE Gateway rule failed. Failed to create an MSE microservices gateway route.
    400 InternalApiError An exception occurred when calling mse:%s, error message: %s.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.