All Products
Search
Document Center

Alibaba Cloud Service Mesh:GetSwimLaneList

Last Updated:Nov 26, 2024

Queries a list of all the lanes in a lane group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
servicemesh:GetSwimLaneListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceMeshIdstringYes

The ID of the Service Mesh (ASM) instance.

xxx
GroupNamestringNo

The name of the lane group.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

yyyy
SwimLaneListarray<object>

The list of all the swimlanes in the lane group.

SwimLaneListobject

The information about swimlanes.

Namestring

The name of the lane.

s1
GroupNamestring

The name of a lane group.

test
LabelSelectorKeystring

The label key of the associated service workload. The value is fixed as ASM_TRAFFIC_TAG.

ASM_TRAFFIC_TAG
LabelSelectorValuestring

The label value of the associated service workload. The value is fixed as ASM_TRAFFIC_TAG.

v1
IngressServicestring

This parameter is deprecated.

mocka.default.svc.cluster.local
IngressRulestring

The request routing rules.

[{"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"}}]}]
ServiceListstring

Services associated with the lane.

["sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb","sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc"]
WeightedIngressDestinatinstring

This parameter is returned only when the IngressRoutingStrategy parameter is set to weighted. This parameter indicates the domain name of Services in each lane and the request routing weight. The value of this parameter is a serialized JSON string.

{"RouteDestination":{"Host":"mocka.default.svc.cluster.local","Subset":"s1"},"Weight":40}

Examples

Sample success responses

JSONformat

{
  "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": ""
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-11-08The response structure of the API has changedView Change Details
2024-05-17The response structure of the API has changedView Change Details
2022-09-28Add OperationView Change Details