GetSwimLaneGroupList - 获取网格实例下所有泳道组列表

调用GetSwimLaneGroupList获取网格实例下所有泳道组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
servicemesh:GetSwimLaneGroupListget
*全部资源
*

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

服务网格 ID。

xxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

yyyy
SwimLaneGroupListarray<object>

泳道组信息列表

SwimLaneGroupListobject

单个泳道组信息

GroupNamestring

泳道组名称。

test
ServiceListstring

泳道组关联的服务列表。

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

引流规则目前仅支持在 ASM 网关下进行配置。

ASM
IngressGatewayNamestring

ASM 网关名称。

ingressgateway
IsPermissiveboolean

流量泳道组是否是宽松模式。

false
FallbackTargetstring

宽松模式泳道组的基线泳道名称。仅在泳道组为宽松模式时,设置此参数有效。

s1
TraceHeaderstring

宽松模式泳道组的链路透传请求头。

my-request-id
RouteHeaderstring

宽松模式流量泳道组的引流请求头。

x-asm-prefer-tag
SwimLaneLabelsstring

一个序列化后的 JSON 字符串,其中 JSON 对象的键为泳道组中所有服务都拥有的标签的键,JSON 对象的值为该标签下泳道组内服务的所有可能的标签值数组。

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

为泳道组内的多个泳道进行请求引流的策略,有两种可能取值:

  • weighted:基于权重的引流策略,即首先以统一的规则对请求进行匹配,对匹配到的请求进行引流,引流时,按照给定的比例将所有请求发往不同的泳道。
  • rule-based:基于规则的引流策略,即泳道组中的每条泳道都拥有自己的匹配规则,只有匹配到泳道对应的引流规则的请求才会被转发到对应的泳道。
weighted
WeightedIngressRulestring

当泳道组的引流策略为 weighted 时可以设定。作用于整个泳道组的引流规则,

{"Domains":["*"],"MatchRequests":[{"URI":{"MatchingMode":"exact","MatchingContent":"/mock"},"Headers":[{"Name":"test","MatchingMode":"exact","MatchingContent":"yes"}]}]}

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-17OpenAPI 返回结构发生变更查看变更详情
2023-09-12OpenAPI 返回结构发生变更查看变更详情
2022-09-28新增 OpenAPI查看变更详情