All Products
Search
Document Center

Serverless App Engine:DescribeSwimmingLane

Last Updated:Dec 17, 2025

Queries details about swimlanes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:DescribeSwimmingLaneget
*All Resources
*
    none
none

Request syntax

GET /pop/v1/cas/gray/describeSwimmingLane HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
NamespaceIdstringNo

The ID of a namespace.

cn-beijing:test
GroupIdlongNo

The ID of the lane group.

2074
LaneIdlongNo

The ID of the lane.

9637

Response parameters

ParameterTypeDescriptionExample
object

The returned information.

RequestIdstring

The request ID.

30375C38-F4ED-4135-A0AE-5C75DC7F****
Messagestring

The returned message. Valid values:

  • The error message returned because the request is normal and success is returned.
  • If the request is abnormal, the specific exception error code is returned.
success
TraceIdstring

The ID of the trace. This parameter is used to query the exact call information.

0a98a02315955564772843261e****
Dataobject

Responses.

LaneIdlong

The ID of the lane.

9488
LaneNamestring

The name of the lane group.

mse-test
LaneTagstring

The label of the lane.

{"alicloud.service.tag":"g1"}
Enableboolean

Lane status:

  • true: enabled
  • false: disabled
true
EnableRulesboolean

Whether the traffic rule is enabled.

true
CanaryModelinteger

The routing mode for end-to-end canary release.

  • 0: routing based on request content
  • 1: routing based on percentages
0
Appsarray<object>

The apps.

appobject

The application information.

AppIdstring

The ID of the application.

6b4c0f64-f679-4580-8105-91eac4******
AppNamestring

The name of the application.

test
MseAppIdstring

The ID of the MSE instance.

mse-cn-53y49******
MseAppNamestring

The name of the MSE instance.

sae-test
mseNamespaceIdstring

The ID of the MSE namespace.

6733e538-d52f-48e6-91a4-192f91******
AppEntryRuleobject

Apply ingress rules.

Pathsarray

The request path.

pathstring

The URL path.

/Path
Percentageinteger

The traffic ratio. Valid values: 0 to 100.

50
ConditionJoinerstring

Logical connectors between conditions:

  • AND: All conditions are met at the same time.
  • OR: Any condition is met.
AND
Conditionsarray<object>

The matching condition.

conditionobject

The condition item.

Typestring

Parameter type.

Header
Namestring

The name of the parameter.

t
Conditionstring

The matching rule.

==
Valuestring

The match value of the condition.

g1
Valuesarray

The match value of the condition.

valuestring

The match value of the condition.

g1
IndependentPercentageEnableboolean

Whether to enable proportional grayscale.

true
PercentageByPathobject

Traffic matching.

integer

The traffic ratio.

100
MseGatewayEntryRuleobject

MSE gateway routes.

RouteIdsarray

The list of route IDs.

routeIdlong

The ID of the route.

["1001","1002"]
Routesarray<object>

The detailed configuration of the routing rule.

routeobject

The route configurations.

RouteIdlong

The route ID.

9504
RouteNamestring

The name of the route.

demo
RoutePredicateobject

The routing rule.

PathPredicateobject

The path matching rule.

Pathstring

The path.

/Path
Typestring

The matching rule.

Header
Percentageinteger

The proportion of path traffic.

100
Conditionsarray<object>

The matching condition.

conditionobject

Item

Typestring

The type of the parameter.

Header
Namestring

The parameter name.

t
Conditionstring

The matching rule.

==
Valuestring

The match value of the condition.

g1
PercentageByRouteobject

The traffic configuration.

integer

Configure the traffic ratio. The range is 1 to 100.

100
IndependentPercentageEnableboolean

Whether to enable proportional grayscale.

true
ConditionJoinerstring

The logical connector between conditions.

AND
ErrorCodestring

The status code. Value values:

  • If the request was successful, ErrorCode is not returned.
  • If the request failed, ErrorCode is returned. For more information, see Error codes in this topic.
Codestring

The HTTP status code or the error code. Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the request was successful. Valid values: Valid values:

  • true: The information was queried.
  • false: Query failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "LaneId": 9488,
    "LaneName": "mse-test",
    "LaneTag": {
      "alicloud.service.tag": "g1"
    },
    "Enable": true,
    "EnableRules": true,
    "CanaryModel": 0,
    "Apps": [
      {
        "AppId": "6b4c0f64-f679-4580-8105-91eac4******",
        "AppName": "test",
        "MseAppId": "mse-cn-53y49******",
        "MseAppName": "sae-test",
        "mseNamespaceId": "6733e538-d52f-48e6-91a4-192f91******"
      }
    ],
    "AppEntryRule": {
      "Paths": [
        "/Path"
      ],
      "Percentage": 50,
      "ConditionJoiner": "AND",
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1",
          "Values": [
            "g1"
          ]
        }
      ],
      "IndependentPercentageEnable": true,
      "PercentageByPath": {
        "key": 100
      }
    },
    "MseGatewayEntryRule": {
      "RouteIds": [
        0
      ],
      "Routes": [
        {
          "RouteId": 9504,
          "RouteName": "demo\n",
          "RoutePredicate": {
            "PathPredicate": {
              "Path": "/Path",
              "Type": "Header"
            }
          }
        }
      ],
      "Percentage": 100,
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1"
        }
      ],
      "PercentageByRoute": {
        "key": 100
      },
      "IndependentPercentageEnable": true,
      "ConditionJoiner": "AND"
    }
  },
  "ErrorCode": "",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.NotEmptyYou must specify the parameter %s.-
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.-
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s-
400MseGatewayRule.CreateFailedCreate MSE Gateway rule failed.Failed to create an MSE microservices gateway route.
400InternalApiErrorAn exception occurred when calling mse:%s, error message: %s.-

For a list of error codes, visit the Service error codes.