All Products
Search

This Product

    Alibaba Cloud Service Mesh:GetSwimLaneGroupList

    Document Center

    Alibaba Cloud Service Mesh:GetSwimLaneGroupList

    Last Updated:Mar 05, 2024

    Queries a list of all lane groups in an Alibaba Cloud Service Mesh (ASM) instance.

    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 ASM instance ID.

    		xxxx

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		yyyy
    SwimLaneGroupListobject []

    The information about the lane groups.

    GroupNamestring

    The name of the lane group.

    		test
    ServiceListstring

    The services associated with the lane group.

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

    Set the value to ASM.

    		ASM
    IngressGatewayNamestring

    The name of the ASM ingress gateway.

    		ingressgateway
    IsPermissiveboolean

    Indicates whether the lane group is in permissive mode.

    		false
    FallbackTargetstring

    The name of the baseline lane of the lane group in permissive mode. This parameter is valid only for a lane group in permissive mode.

    		s1
    TraceHeaderstring

    The end-to-end (E2E) pass-through request header of the lane group. It is valid only for a lane group in permissive mode.

    		my-request-id
    RouteHeaderstring

    The request routing header of the lane group. It is valid only for a lane group in permissive mode.

    		x-asm-prefer-tag
    SwimLaneLabelsstring

    A serialized JSON string. The keys of the JSON object are the keys of the labels owned by all services in the lane group, and the values of the JSON object are arrays of all possible label values of the services in the lane group.

    		{"ASM_TRAFFIC_TAG":["v2","v3","v1"],"version":["v3","v1","v2"]}

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The 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