GetSwimLaneGroupList - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Lists all traffic lane groups in a Service Mesh (ASM) instance.

Operation description

You can call the DescribeASMSidecarExpectedVersion API to query the expected version of sidecars in the ASM data plane. For example, if a sidecar is injected with version v1.11 prior to an ASM upgrade, and the ASM instance is then upgraded to v1.12, the actual version of the sidecar will remain v1.11 as long as the Pod is not restarted. However, invoking this API will return v1.12 as the expected version.

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 ID of the Service Mesh (ASM) instance.	xxxx

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	yyyy
SwimLaneGroupList	array<object>	A list of traffic lane groups.
	object	The details of a traffic lane group.
GroupName	string	The name of the traffic lane group.	test
ServiceList	string	A serialized JSON string that lists the services associated with the traffic lane group.	["sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc"]
IngressType	string	The type of ingress gateway. Only ASM gateways support traffic shifting. The value must be `ASM`.	ASM
IngressGatewayName	string	The name of the ASM gateway.	ingressgateway
IsPermissive	boolean	Specifies whether the traffic lane group is in loose mode.	false
FallbackTarget	string	The name of the baseline traffic lane for the traffic lane group. This parameter applies only if the group is in loose mode (`IsPermissive` is `true`).	s1
TraceHeader	string	The request header for trace pass-through in a traffic lane group that is in loose mode.	my-request-id
RouteHeader	string	The request header for traffic shifting when the traffic lane group is in loose mode.	x-asm-prefer-tag
SwimLaneLabels	string	A serialized JSON string. Each key represents a label key that is common to all services in the traffic lane group. The corresponding value is an array of all possible values for that label key.	{"ASM_TRAFFIC_TAG":["v2","v3","v1"],"version":["v3","v1","v2"]}
IngressRoutingStrategy	string	The policy for shifting traffic to different traffic lanes within the traffic lane group. Valid values: `weighted`: A policy that distributes traffic based on weights. A single rule matches requests, and the policy then distributes matched requests to different traffic lanes based on specified proportions. `rule-based`: A policy that routes traffic based on specific rules. Each traffic lane has a unique matching rule, and a request is routed to a lane only if it matches that lane's rule. Valid values: weighted : weighted rule-based : rule-based	weighted
WeightedIngressRule	string	The traffic shifting rule for the entire traffic lane group. This parameter applies only when the traffic shifting policy is `weighted`.	{"Domains":["*"],"MatchRequests":[{"URI":{"MatchingMode":"exact","MatchingContent":"/mock"},"Headers":[{"Name":"test","MatchingMode":"exact","MatchingContent":"yes"}]}]}
ServiceLevelFallbackTarget	string	Specifies a fallback version for each service. This setting overrides the group-level fallback policy.

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\"}]}]}",
      "ServiceLevelFallbackTarget": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.