GetSwimLaneList - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Call GetSwimLaneList to retrieve a list of all swimlanes in a swimlane group.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The Service Mesh instance ID.	xxx
GroupName	string	No	The name of the swimlane group.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	yyyy
SwimLaneList	array<object>	A list of swimlanes.
	object	The information about a swimlane.
Name	string	The name of the swimlane.	s1
GroupName	string	The name of the swimlane group.	test
LabelSelectorKey	string	The label key for the associated service workload. The value is fixed to `ASM_TRAFFIC_TAG`.	ASM_TRAFFIC_TAG
LabelSelectorValue	string	The value of the `ASM_TRAFFIC_TAG` label.	v1
IngressService	string	This parameter is deprecated.	mocka.default.svc.cluster.local
IngressRule	string	The traffic routing rule.	[{"Domains":[""],"RouteName":"r1","MatchRequest":{"Headers":[{"Name":"x-asm-prefer-tag","MatchingMode":"exact","MatchingContent":"s1"}],"URI":{"MatchingMode":"exact","MatchingContent":"/mock"}},"RouteDestinations":[{"Destination":{"Host":"mocka.default.svc.cluster.local","Subset":"s1"}}]},{"Domains":[""],"RouteName":"hello","MatchRequest":{"Headers":[{"Name":"x-asm-prefer-tag","MatchingMode":"exact","MatchingContent":"s1"}],"URI":{"MatchingMode":"exact","MatchingContent":"/mocktest"}},"RouteDestinations":[{"Destination":{"Host":"mocka.default.svc.cluster.local","Subset":"s1"}}]}]
ServiceList	string	A list of associated services.	["sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc"]
WeightedIngressDestinatin	string	This parameter is available when the traffic routing policy of the swimlane group is `weighted`. The value is a JSON-serialized string that specifies the ingress service domain name and traffic weight for the swimlane.	{"RouteDestination":{"Host":"mocka.default.svc.cluster.local","Subset":"s1"},"Weight":40}
ValidationMessage	string	A list of validation messages for the swimlane. If an issue occurs, such as a service in the swimlane group not existing, this list displays the corresponding validation information. If the configuration is successful and takes effect, `null` is returned.	[{"code":"CODE_UNEFFECTED_SWIMLANE_LABEL","level":"warning","message":"The label selector defined in the ASMSwimLane has no effect on any workload instance."}]

Examples

Success response

JSON format

{
  "RequestId": "yyyy",
  "SwimLaneList": [
    {
      "Name": "s1",
      "GroupName": "test",
      "LabelSelectorKey": "ASM_TRAFFIC_TAG",
      "LabelSelectorValue": "v1",
      "IngressService": "mocka.default.svc.cluster.local",
      "IngressRule": "[{\"Domains\":[\"*\"],\"RouteName\":\"r1\",\"MatchRequest\":{\"Headers\":[{\"Name\":\"x-asm-prefer-tag\",\"MatchingMode\":\"exact\",\"MatchingContent\":\"s1\"}],\"URI\":{\"MatchingMode\":\"exact\",\"MatchingContent\":\"/mock\"}},\"RouteDestinations\":[{\"Destination\":{\"Host\":\"mocka.default.svc.cluster.local\",\"Subset\":\"s1\"}}]},{\"Domains\":[\"*\"],\"RouteName\":\"hello\",\"MatchRequest\":{\"Headers\":[{\"Name\":\"x-asm-prefer-tag\",\"MatchingMode\":\"exact\",\"MatchingContent\":\"s1\"}],\"URI\":{\"MatchingMode\":\"exact\",\"MatchingContent\":\"/mocktest\"}},\"RouteDestinations\":[{\"Destination\":{\"Host\":\"mocka.default.svc.cluster.local\",\"Subset\":\"s1\"}}]}]",
      "ServiceList": "[\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc\"]",
      "WeightedIngressDestinatin": "{\"RouteDestination\":{\"Host\":\"mocka.default.svc.cluster.local\",\"Subset\":\"s1\"},\"Weight\":40}",
      "ValidationMessage": "[{\"code\":\"CODE_UNEFFECTED_SWIMLANE_LABEL\",\"level\":\"warning\",\"message\":\"The label selector defined in the ASMSwimLane has no effect on any workload instance.\"}]"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.