DescribeSwimmingLane API Overview for Swimlane Configuration - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Retrieves the details of 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:DescribeSwimmingLane

get

*All Resource

*

None

Request syntax

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

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The information returned.
RequestId	string	The request ID.	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	The message returned with the response. success is returned if the request is successful. An error code is returned if the request fails.	success
TraceId	string	The trace ID. You can use this ID to query the details of a call.	0a98a02315955564772843261e****
Data	object	The data returned.
LaneId	integer	The ID of the lane.	9488
LaneName	string	The name of the lane.	mse-test
LaneTag	string	The tag of the lane.	{"alicloud.service.tag":"g1"}
Enable	boolean	Indicates whether the lane is enabled. `true`: enabled `false`: disabled	true
EnableRules	boolean	Indicates whether traffic rules are enabled.	true
CanaryModel	integer	The mode for the end-to-end canary release. Valid values: `0`: content-based routing `1`: percentage-based routing	0
Apps	array<object>	A list of associated applications.
	object	An application that is associated with the lane.
AppId	string	The ID of the application.	6b4c0f64-f679-4580-8105-91eac4******
AppName	string	The name of the application.	test
MseAppId	string	The ID of the MSE instance.	mse-cn-53y49******
MseAppName	string	The name of the MSE instance.	sae-test
mseNamespaceId	string	The ID of the MSE namespace.	6733e538-d52f-48e6-91a4-192f91******
AppEntryRule	object	The application entry rule.
Paths	array	The request paths.
	string	A request path.	/Path
Percentage	integer	The traffic percentage for percentage-based routing. Valid values: 0 to 100.	50
ConditionJoiner	string	The logical operator that joins conditions. Valid values: `AND`: All conditions must be met. `OR`: At least one of the conditions must be met.	AND
Conditions	array<object>	The match conditions.
	object	A match condition.
Type	string	The type of the parameter.	Header
Name	string	The name of the parameter.	t
Condition	string	The match operator.	==
Value	string	The value to match.	g1
Values	array	The values to match.
	string	A value to match.	g1
IndependentPercentageEnable	boolean	Indicates whether percentage-based canary release is enabled.	true
PercentageByPath	object	An object that maps paths to traffic percentages.
	integer	The traffic percentage.	100
MseGatewayEntryRule	object	The entry rule for the MSE Gateway.
RouteIds	array	A list of route IDs.
	integer	A route ID.	["1001","1002"]
Routes	array<object>	The route configurations.
	array<object>	A route configuration.
RouteId	integer	The route ID.	9504
RouteName	string	The name of the route.	demo
RoutePredicate	object	The route predicate.
PathPredicate	object	The path-based match rule.
Path	string	The path.	/Path
Type	string	The match type.	Header
Percentage	integer	The traffic percentage for the rule.	100
Conditions	array<object>	The match conditions.
	object	A match condition.
Type	string	The type of the parameter.	Header
Name	string	The name of the parameter.	t
Condition	string	The match operator.	==
Value	string	The value to match.	g1
PercentageByRoute	object	An object that maps route IDs to traffic percentages.
	integer	The traffic percentage. Valid values: 1 to 100.	100
IndependentPercentageEnable	boolean	Indicates whether percentage-based canary release is enabled.	true
ConditionJoiner	string	The logical operator that joins conditions.	AND
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code that is returned. 2xx: Success. 3xx: Redirection. 4xx: Client error. 5xx: Server error.	200
Success	boolean	Indicates whether the request was successful. true: The query was successful. false: The query failed.	true

Examples

Success response

JSON format

{
  "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 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.