QueryAllSwimmingLane - Microservices Engine - Alibaba Cloud Documentation Center

Queries information about all lanes.

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

get

*GovernanceNamespace

acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The name of the MSE namespace.	default
GroupId	integer	Yes	The ID of the lane group.	186
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	DC34E4A3-5F1C-4E40-86EA-02EDF967****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	The error code.	mse-100-000
Message	string	The returned message.	The request was successfully processed.
Data	array<object>	Data Overview.	[{id:100,name:"test"}]
	object
Name	string	The name of the lane group.	swimmingGroup
UserId	string	The ID of the user to which the lane belongs.	12345
MessageQueueFilterSide	string	The side on which canary release for messages is implemented.	Client
Enable	string	Indicates whether the lane is enabled.	true
Namespace	string	The MSE namespace to which the lane belongs.	default
RecordCanaryDetail	boolean	Indicates whether to record the request details. This is for the observability of end-to-end canary releases.	false
Id	integer	The lane ID.	123
RegionId	string	The region ID.	cn-hangzhou
MessageQueueGrayEnable	boolean	Indicates whether canary release for messages is enabled.	false
enableRules	boolean	Indicates whether rules are enabled.	true
EntryRules	array<object>	The list of rules for the ingress application.
	object	The rule for the ingress application.
paths	array	The list of paths.
	string	The path.	/
path	string	The path.	/adump/wxb/prod
condition	string	The condition.	AND
restItems	array<object>	The list of RESTful matching rules.
	object	The RESTful matching rule.
type	string	The matching type.	cookie
name	string	The name.	test
operator	string	The operator.	rawvalue
nameList	array	The list of items to match.
	string	The name of the item to match.	test
datum	string	The value.	x
cond	string	The matching operator.	==
divisor	integer	The divisor.	10
remainder	integer	The remainder.	10
rate	integer	The percentage.	30
value	string	The value.	test
gmtCreate	string	The time when the lane was created.	1683598484000
gmtModified	string	The time when the lane was last updated.	1683598484000
groupId	string	The ID of the lane group.	72709
GroupId	string	The ID of the lane group.	6859
tag	string	The tag of the lane.	gray
Tag	string	The tag of the lane.	gray
GatewaySwimmingLaneRoute	object	The information about the gateway route. This parameter is used when a cloud-native gateway or an API Gateway instance is used as the ingress.
GatewayId	integer	The gateway ID.	1
GatewayUniqueId	string	The unique ID of the gateway.	gw-84efde2ee1464260bdb17a5b****
RouteIdList	array	The list of route IDs. This parameter is optional if the canary release is effective at the gateway level.
	integer	The route ID.	1
CanaryModel	integer	The mode of the end-to-end canary release. Valid values: 0: route by the content of the request 1: route by proportion	0
Conditions	array<object>	The list of matching conditions. This parameter is used when you route requests by content.
	object	The matching condition.
Name	string	The parameter name.	name
Value	string	The parameter value.	xiaoming
Type	string	The parameter type. Valid values: header: Header param: Parameter	header
Cond	string	The condition. Valid values: PRE: prefix match EQUAL: exact match REGULAR: regular expression match	PRE
NameList	array	NameList
	string	Name	name
Percentage	integer	The traffic proportion. This parameter is used when you route requests by proportion. Valid values: 0 to 100.	20
RouteIndependentPercentageEnable	string	Indicates whether to independently set the percentage for each path.	true
RouteIndependentPercentageList	array<object>	The list of routes and percentages.
	object
RouteId	string	The route ID.	12345
Percentage	string	The percentage.	60
Condition	string	The condition for the canary release.	AND、OR
PathIndependentPercentageEnable	boolean	Indicates whether to set the percentage for each path.	true
GatewaySwimmingLaneRouteJson	string	The information about the gateway. This parameter is used when an MSE cloud-native gateway or a cloud-native API Gateway instance is used as the ingress.	{\"GatewayUniqueId\":\"gw-cf815503e0a8441b8956d8e349fa8fb5\",\"Percentage\":0,\"RouteIdList\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\"CanaryModel\":1,\"Conditions\":[]}

Examples

Success response

JSON format

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Message": "The request was successfully processed.\n",
  "Data": [
    {
      "Name": "swimmingGroup",
      "UserId": "12345",
      "MessageQueueFilterSide": "Client",
      "Enable": "true",
      "Namespace": "default",
      "RecordCanaryDetail": false,
      "Id": 123,
      "RegionId": "cn-hangzhou",
      "MessageQueueGrayEnable": false,
      "enableRules": true,
      "EntryRules": [
        {
          "paths": [
            "/"
          ],
          "path": "/adump/wxb/prod",
          "condition": "AND",
          "restItems": [
            {
              "type": "cookie",
              "name": "test",
              "operator": "rawvalue",
              "nameList": [
                "test"
              ],
              "datum": "x",
              "cond": "==",
              "divisor": 10,
              "remainder": 10,
              "rate": 30,
              "value": "test"
            }
          ]
        }
      ],
      "gmtCreate": "1683598484000",
      "gmtModified": "1683598484000",
      "groupId": "72709",
      "GroupId": "6859",
      "tag": "gray",
      "Tag": "gray",
      "GatewaySwimmingLaneRoute": {
        "GatewayId": 1,
        "GatewayUniqueId": "gw-84efde2ee1464260bdb17a5b****",
        "RouteIdList": [
          1
        ],
        "CanaryModel": 0,
        "Conditions": [
          {
            "Name": "name",
            "Value": "xiaoming",
            "Type": "header",
            "Cond": "PRE",
            "NameList": [
              "name"
            ]
          }
        ],
        "Percentage": 20,
        "RouteIndependentPercentageEnable": "true",
        "RouteIndependentPercentageList": [
          {
            "RouteId": "12345",
            "Percentage": "60"
          }
        ],
        "Condition": "AND、OR"
      },
      "PathIndependentPercentageEnable": true,
      "GatewaySwimmingLaneRouteJson": "{\\\"GatewayUniqueId\\\":\\\"gw-cf815503e0a8441b8956d8e349fa8fb5\\\",\\\"Percentage\\\":0,\\\"RouteIdList\\\":[32295,32298,32297,32309,32307,32294,32303,32292,32299,35278],\\\"CanaryModel\\\":1,\\\"Conditions\\\":[]}"
    }
  ]
}

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.