GetSwimLaneGroupList - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries a list of all lane groups in an Alibaba Cloud Service Mesh (ASM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ASM instance ID.	xxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	yyyy
SwimLaneGroupList	object []	The information about the lane group.
GroupName	string	The name of a lane group.	test
ServiceList	string	The Services associated with the lane group.	["sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc"]
IngressType	string	The type of gateways in which you can configure request routing rules. You can configure request routing rules only in ASM gateways.	ASM
IngressGatewayName	string	The name of the ASM ingress gateway.	ingressgateway
IsPermissive	boolean	Indicates whether the lane group is in permissive mode.	false
FallbackTarget	string	The name of the baseline lane of the lane group in permissive mode. This parameter is valid only for a lane group in permissive mode.	s1
TraceHeader	string	The end-to-end (E2E) pass-through request header of the lane group. It is valid only for a lane group in permissive mode.	my-request-id
RouteHeader	string	The request routing header of the lane group. It is valid only for a lane group in permissive mode.	x-asm-prefer-tag
SwimLaneLabels	string	A serialized JSON string. The keys of the JSON object are the keys of the labels owned by all services in the lane group, and the values of the JSON object are arrays of all possible label values of the services in the lane group.	{"ASM_TRAFFIC_TAG":["v2","v3","v1"],"version":["v3","v1","v2"]}
IngressRoutingStrategy	string	The policy used to route requests among multiple lanes in a lane group. Valid values: weighted: a weight-based request routing policy. Requests are matched based on uniform rules and then routed to different lanes in a lane group at a specified ratio. rule-based: a rule-based request routing policy. Each lane is configured with request routing rules. Only requests that match the request routing rules of a specific lane are routed to the lane.	weighted
WeightedIngressRule	string	The weight-based request routing rules for a lane group. This parameter is returned only when the IngressRoutingStrategy parameter is set to weighted.	{"Domains":["*"],"MatchRequests":[{"URI":{"MatchingMode":"exact","MatchingContent":"/mock"},"Headers":[{"Name":"test","MatchingMode":"exact","MatchingContent":"yes"}]}]}

Examples

Sample success responses

JSONformat

{
  "RequestId": "yyyy",
  "SwimLaneGroupList": [
    {
      "GroupName": "test",
      "ServiceList": "[\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc\"]",
      "IngressType": "ASM",
      "IngressGatewayName": "ingressgateway",
      "IsPermissive": false,
      "FallbackTarget": "s1",
      "TraceHeader": "my-request-id",
      "RouteHeader": "x-asm-prefer-tag",
      "SwimLaneLabels": "{\"ASM_TRAFFIC_TAG\":[\"v2\",\"v3\",\"v1\"],\"version\":[\"v3\",\"v1\",\"v2\"]}",
      "IngressRoutingStrategy": "weighted",
      "WeightedIngressRule": "{\"Domains\":[\"*\"],\"MatchRequests\":[{\"URI\":{\"MatchingMode\":\"exact\",\"MatchingContent\":\"/mock\"},\"Headers\":[{\"Name\":\"test\",\"MatchingMode\":\"exact\",\"MatchingContent\":\"yes\"}]}]}"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-05-17

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-12

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2022-09-28

Add Operation

see changesets