文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 泳道/ 根据微服务引擎ID获取所有泳道
更新时间：2025-06-30 GMT+08:00
查看PDF
分享

根据微服务引擎ID获取所有泳道

功能介绍

此API用于根据微服务引擎ID获取所有泳道。

URI

GET /v3/{project_id}/cas/swimlane

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。
表2 查询参数

参数

是否必选

参数类型

描述

engine_id

是

String

微服务引擎ID。获取方法，请参考8.2.2.2-查询微服务引擎专享版列表。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

泳道总数。

swimlanes

Array of objects

泳道列表，请参考表5。
表5 swimlanes

参数

参数类型

描述

id

String

泳道ID。

name

String

泳道名称。

swimlane_group_id

String

所属的泳道组ID。

type

String

泳道类型。

  • BASE：基线泳道。
  • GRAY：灰度泳道。

tag

String

泳道标签，根据标签来控制流量的走向。

route_status

String

泳道路由状态。

  • ENABLE：开启路由。
  • DISABLED：关闭路由。

rule_match_mode

String

路由规则匹配模式。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。

  • ALL：匹配所有的规则。
  • ANY：匹配任一规则。

rules

Array of objects

路由规则。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。请参考表6。

weight

Integer

泳道流量权重。范围在0-100之间。

当泳道组灰度类型为基于流量，即gray_release_type为WEIGHT时生效。

project_id

String

项目ID。

create_time

Integer

创建时间。

update_time

Integer

更新时间。

creator

String

创建人。

swimlane_group

Object

泳道组信息，请参考表表7。
表6 rules

参数

参数类型

描述

type

String

灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。

key

String

键。

value

String

值。

condition

String

匹配条件。

  • EXACT：精确匹配。
  • PREFIX：前缀匹配。
  • REGEX：正则匹配。
表7 swimlane_group

参数

参数类型

描述

id

String

泳道组ID。

name

String

泳道组名称。

gray_release_type

String

泳道组灰度策略。

description

String

泳道组描述。

gateways

Array of objects

流量网关入口，请参考表8。
表8 gateways

参数

参数类型

描述

engine_id

String

引擎ID。

id

String

网关ID。

name

String

网关名称。

target_services

Array of objects

目标服务列表，请参考表9。
表9 target_services

参数

参数类型

描述

host

String

目标服务host信息。

host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称以及微服务接入的引擎类型组成，以点号（.）分隔。

例如，unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称，testing为unit-controller微服务所在环境名，test-application为unit-controller微服务所属应用名称，servicecomb表示unit-controller微服务接入的是ServiceComb引擎。

name

String

目标服务名称。

id

String

目标服务ID。

engine_id

String

引擎ID。

engine_type

String

引擎类型。

  • servicecomb：ServiceComb引擎。
  • nacos：注册配置中心。

请求示例

无

响应示例

{
  "swimlanes": [
    {
      "id": "8c6274b9-113e-4066-9b1c-320fe5ae327b",
      "name": "baselane",
      "swimlane_group_id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75",
      "type": "BASE",
      "tag": "base",
      "weight": 100,
      "route_status": "ENABLE",
      "swimlane_group": {
        "routeInGroupTags": null,
        "gateways": [
          {
            "id": "6b44bcf9-99e9-46f4-9ab5-7670456073fc",
            "name": "microGateway-pyy-0127-1",
            "target_services": [
              {
                "id": "e882070c-7d02-4db1-8b84-619ee88f1a25",
                "host": "unit-provider-all..wulumuqi.servicecomb",
                "name": "unit-provider-all"
              }
            ],
            "engine_id": "b4032a08-b09d-47e4-a01f-596906df6f55"
          }
        ],
        "id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75",
        "name": "test-wqd",
        "gray_release_type": "WEIGHT",
        "description": "111"
      }
    }
  ],
  "count": 1
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

请参考ServiceStage错误码。

父主题： 泳道

相关文档