GetSwimLaneGroupList - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Call GetSwimLaneGroupList to retrieve a list of all traffic lane groups in a Service Mesh instance.

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

servicemesh:GetSwimLaneGroupList

get

*All Resource

*

None

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	yyyy
SwimLaneGroupList	array<object>	The list of traffic lane groups.
	object	The information about a single traffic lane group.
GroupName	string	The name of the traffic lane group.	test
ServiceList	string	The list of services associated with the traffic lane group.	["sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc"]
IngressType	string	Traffic shifting rules can be configured only for ASM gateways.	ASM
IngressGatewayName	string	The name of the ASM gateway.	ingressgateway
IsPermissive	boolean	Indicates whether the traffic lane group is in loose mode.	false
FallbackTarget	string	The name of the baseline traffic lane for a traffic lane group in loose mode. This parameter is valid only when the traffic lane group is in loose mode.	s1
TraceHeader	string	The request header for trace pass-through for a traffic lane group in loose mode.	my-request-id
RouteHeader	string	The request header for traffic shifting for a traffic lane group in loose mode.	x-asm-prefer-tag
SwimLaneLabels	string	A serialized JSON string. The keys of the JSON object are the keys of tags shared by all services in the traffic lane group. The values of the JSON object are arrays of all possible tag values for the services within the group.	{"ASM_TRAFFIC_TAG":["v2","v3","v1"],"version":["v3","v1","v2"]}
IngressRoutingStrategy	string	The policy for shifting requests to different traffic lanes in the group. Valid values: weighted: A weight-based policy. Requests are matched based on a unified rule. Matched requests are then forwarded to different traffic lanes based on specified proportions. rule-based: A rule-based policy. Each traffic lane in the group has its own matching rule. A request is forwarded to a specific traffic lane only if it matches the rule of that lane.	weighted
WeightedIngressRule	string	The traffic shifting rule that applies to the entire traffic lane group. This parameter is valid only when the traffic shifting policy of the group is weighted.	{"Domains":["*"],"MatchRequests":[{"URI":{"MatchingMode":"exact","MatchingContent":"/mock"},"Headers":[{"Name":"test","MatchingMode":"exact","MatchingContent":"yes"}]}]}

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.