All Products
Search
Document Center

Alibaba Cloud Service Mesh:GetSwimLaneDetail

Last Updated:Jun 20, 2024

Queries detailed information about a lane.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceMeshIdstringYes

The ID of the Service Mesh (ASM) instance.

xxx
SwimLaneNamestringNo

The name of the lane.

s1
GroupNamestringNo

The name of the lane group.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

yyyy
ServicesListstring

A list of services associated with the lane.

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

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

ASM_TRAFFIC_TAG
LabelSelectorValuestring

The value of ASM_TRAFFIC_TAG.

v1
IngressServicestring

This parameter is deprecated.

mocka.default.svc.cluster.local
IngressRulestring

The traffic routing rule that routes traffic to the lane by using the ingress gateway. The traffic routing rule contains one or more custom routes.

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

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",
  "ServicesList": "[\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mocka\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockb\",\"sh01/c089443ea9e50403fa4f0a6237d11e0a9/default/mockc\"]",
  "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\"}}]}]",
  "WeightedIngressDestination": "{\"RouteDestination\":{\"Host\":\"mocka.default.svc.cluster.local\",\"Subset\":\"s1\"},\"Weight\":40}"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-09-28Add Operationsee changesets