文档

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

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

服务网格 ID。

xxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

yyyy
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"]}

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-28新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈