ListAllSwimmingLanes API Reference for Swimlane Queries - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Lists all swimlanes.

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:ListAllSwimmingLanes

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The namespace ID.	cn-beijing:test
GroupId	integer	No	The swimming lane group ID.	2074

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Message	string	The response message. Valid values: Returns success if the request is successful. Returns a specific error code if the request fails.	success
TraceId	string	The trace ID used to query the details of a request.	0a98a02315955564772843261e****
Data	array<object>	The response data.
	array<object>	The details of the swimming lanes.
LaneId	integer	The swimming lane ID.	16401
LaneName	string	The swimming lane name.	test
LaneTag	string	The swimming lane tag.	g1
CanaryModel	integer	The canary model for the end-to-end canary release: 0: Route by request content. 1: Route by percentage.	0
Enable	boolean	Indicates whether the swimming lane is enabled. true: enabled false: disabled	true
EnableRules	boolean	Indicates whether traffic rules are enabled.	true
Apps	array<object>	The applications associated with the swimming lane.
	object	The application details.
AppId	string	The application ID.	8ea0c468-8165-416d-beae-531abb******
AppName	string	The application name.	test
MseAppId	string	The MSE instance ID.	mse-cn-53y49******
MseAppName	string	The MSE instance name.	sae-test
MseNamespaceId	string	The ID of the namespace in which the MSE instance resides.	sae-ent
AppEntryRule	object	The application entry rule.
Paths	array	The request paths.
	string	A request path.	/
Percentage	integer	The percentage of traffic (0-100) to be routed when the route by percentage model is used.	50
ConditionJoiner	string	The logical operator used to join conditions: AND: All conditions must be met. OR: One of the conditions must be met.	AND
Conditions	array<object>	The matching conditions.
	object	A matching condition.
Type	string	The parameter type.	Header
Name	string	The parameter name.	t
Condition	string	The matching rule.	==
Value	string	The value to match in the condition.	g1
Values	array	The values to match in the condition.
	string	A value to match in the condition.	g1
IndependentPercentageEnable	boolean	Indicates whether to enable canary release by percentage.	true
PercentageByPath	object	A map of paths to their corresponding traffic percentages.
	integer	The traffic percentage.	100
MseGatewayEntryRule	object	The MSE gateway route.
RouteIds	array	The route IDs.
	integer	A route ID.	103092
Routes	array<object>	The route configurations.
	array<object>	The route configuration.
RouteId	integer	The route ID.	9504
RouteName	string	The route name.	demo
RoutePredicate	object	The route's matching rule.
PathPredicate	object	The path matching rule.
path	string	The path.	/Path
type	string	The matching rule.	Header
Percentage	integer	The percentage of traffic for the path.	100
ConditionJoiner	string	The logical operator used to join conditions.	AND
Conditions	array<object>	The matching conditions.
	object	A condition item.
Type	string	The parameter type.	Header
Name	string	The parameter name.	t
Condition	string	The matching rule.	==
Value	string	The value to match in the condition.	g1
IndependentPercentageEnable	boolean	Indicates whether to enable canary release by percentage.	true
PercentageByRoute	object	A map of route IDs to their corresponding traffic percentages.
	integer	The traffic percentage. Valid values: 1 to 100.	"2":1
ErrorCode	string	The error code. The ErrorCode parameter is omitted if the request is successful. The ErrorCode parameter is returned if the request fails. For details, see the Error codes section in this topic.
Code	string	The HTTP status code returned. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: The request is invalid. 5xx: A server error occurs.	200
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "LaneId": 16401,
      "LaneName": "test",
      "LaneTag": "g1\n",
      "CanaryModel": 0,
      "Enable": true,
      "EnableRules": true,
      "Apps": [
        {
          "AppId": "8ea0c468-8165-416d-beae-531abb******",
          "AppName": "test",
          "MseAppId": "mse-cn-53y49******",
          "MseAppName": "sae-test",
          "MseNamespaceId": "sae-ent\n"
        }
      ],
      "AppEntryRule": {
        "Paths": [
          "/"
        ],
        "Percentage": 50,
        "ConditionJoiner": "AND",
        "Conditions": [
          {
            "Type": "Header",
            "Name": "t",
            "Condition": "==",
            "Value": "g1",
            "Values": [
              "g1"
            ]
          }
        ],
        "IndependentPercentageEnable": true,
        "PercentageByPath": {
          "key": 100
        }
      },
      "MseGatewayEntryRule": {
        "RouteIds": [
          103092
        ],
        "Routes": [
          {
            "RouteId": 9504,
            "RouteName": "demo\n",
            "RoutePredicate": {
              "PathPredicate": {
                "path": "/Path\n",
                "type": "Header\n"
              }
            }
          }
        ],
        "Percentage": 100,
        "ConditionJoiner": "AND",
        "Conditions": [
          {
            "Type": "Header\n",
            "Name": "t\n",
            "Condition": "==\n",
            "Value": "g1\n"
          }
        ],
        "IndependentPercentageEnable": true,
        "PercentageByRoute": {
          "key": 0
        }
      }
    }
  ],
  "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.