文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API(v3版本)/ 泳道组/ 根据泳道组ID获取泳道组信息 - ObtainLaneGroupInformationBasedOnTheLaneGroupID
更新时间:2026-02-28 GMT+08:00
分享

根据泳道组ID获取泳道组信息 - ObtainLaneGroupInformationBasedOnTheLaneGroupID

功能介绍

此API用于根据泳道组ID获取泳道组信息。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    servicestage::getLaneGroup

    read

    -

    -

    servicestage:app:get

    -

URI

GET /v3/{project_id}/cas/swimlane-group/{lane_group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

lane_group_id

String

参数解释:

泳道组ID。获取方法,请参考获取所有泳道组 - ObtainAllLaneGroups

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及

取值范围:

application/json;charset=utf8

默认取值:

不涉及

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应消息

表3 响应参数

参数

参数类型

描述

description

String

参数解释:

泳道组的描述。

取值范围:

不涉及

gateways

Array of objects

参数解释:

流量网关入口,请参考表4

gray_release_type

String

参数解释:

灰度发布类型。

取值范围:

  • WEIGHT:基于流量比例进行全链路灰度。
  • CONTENT:基于内容进行全链路灰度。

id

String

参数解释:

泳道组的ID。

取值范围:

不涉及

name

String

参数解释:

泳道组的名称。

取值范围:

不涉及

swimlane_count

Integer

参数解释:

泳道组下的泳道数量。

取值范围:

不涉及

swimlanes

Array of objects

参数解释:

泳道组下的泳道列表,请参考表6

creator

String

参数解释:

创建者。

取值范围:

不涉及

create_time

String

参数解释:

创建时间。

取值范围:

不涉及

update_time

String

参数解释:

更新时间

取值范围:

不涉及

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

取值范围:

不涉及

target_services

Array of objects

参数解释:

目标服务列表。请参考表5

表4 gateways

参数

参数类型

描述

engine_id

String

参数解释:

网关引擎ID。

取值范围:

不涉及

id

String

参数解释:

网关ID。

取值范围:

不涉及

name

String

参数解释:

网关名称。

取值范围:

不涉及

target_services

Array of objects

参数解释:

目标服务列表。请参考表5

表5 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:注册配置中心。
表6 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时生效。请参考表7

weight

Integer

参数解释:

泳道流量权重。

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

取值范围:

0-100之间

instances

Array of objects

参数解释:

泳道中纳管的组件列表,请参考表8

instance_count

Integer

参数解释:

泳道中纳管的组件个数。

取值范围:

不涉及

latest_opt

String

参数解释:

泳道上一步的操作。

取值范围:

  • CLONE:克隆。
  • UPGRADE:升级。
  • ROLLBACK:回滚。
  • CREATE:创建。

release_plan_id

String

参数解释:

泳道上一步操作关联的发布单ID。

取值范围:

不涉及

project_id

String

参数解释:

项目ID。

取值范围:

不涉及

create_time

Integer

参数解释:

创建时间。

取值范围:

不涉及

update_time

Integer

参数解释:

更新时间。

取值范围:

不涉及

creator

String

参数解释:

创建人。

取值范围:

不涉及

表7 rules

参数

参数类型

描述

type

String

参数解释:

灰度匹配规则类型。

取值范围:

HEADER:基于Header头进行匹配

key

String

参数解释:

键。

取值范围:

不涉及

value

String

参数解释:

值。

取值范围:

不涉及

condition

String

参数解释:

匹配条件。

取值范围:

  • EXACT:精确匹配。
  • PREFIX:前缀匹配。
  • REGEX:正则匹配。
表8 instances

参数

参数类型

描述

id

String

参数解释:

应用组件实例ID。

取值范围:

不涉及

name

String

参数解释:

应用组件实例名称。

取值范围:

不涉及

version

String

参数解释:

应用组件版本号。

取值范围:

不涉及

application_id

String

参数解释:

应用ID。

取值范围:

不涉及

component_id

String

参数解释:

组件ID。

取值范围:

不涉及

application_name

String

参数解释:

应用名称。

取值范围:

不涉及

status

String

参数解释:

实例状态。

取值范围:

  • CREATED:已创建。
  • FAILED:失败。
  • COMPLETE:完成。

engine_id

String

参数解释:

组件关联引擎ID。

取值范围:

不涉及

runtime_stack

Object

参数解释:

运行时,请参考表9

replica

Integer

参数解释:

实例副本数。

取值范围:

不涉及

表9 runtime_stack

参数

参数类型

描述

name

String

参数解释:

技术栈名称。

取值范围:

不涉及

type

String

参数解释:

技术栈类型,支持Java、Tomcat、Nodejs、Php、Docker、Python。

当部署模式为虚机部署时,仅支持Java、Tomcat、Nodejs;容器部署上述类型都支持。

取值范围:

不涉及

version

String

参数解释:

技术栈版本。

取值范围:

不涉及

deploy_mode

String

参数解释:

部署模式。

取值范围:

  • container:容器部署。
  • virtualmachine:虚机部署。

请求示例

响应示例

{
    "gateways": [
        {
            "id": "71949725-9c8f-483a-a05f-74d33ff1613e",
            "name": "microGateway-cy8bhr",
            "target_services": [
                {
                    "id": "8177d237-b912-4167-a90d-33c603610d0b",
                    "host": "provider..demo-java-chassis-cse-v2.servicecomb",
                    "name": "provider",
                    "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067",
                    "engine_type": "servicecomb"
                }
            ],
            "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067"
        }
    ],
    "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e",
    "name": "test",
    "gray_release_type": "WEIGHT",
    "description": "test",
    "project_id": "578ac30b81034b89a7255b3af26db9c9",
    "creator": "test_user",
    "create_time": 1726623793113,
    "update_time": 1726623793113,
    "swimlanes": [
        {
            "id": "1cd0cb71-5d5d-41a0-8b05-f7ed53400cf7",
            "name": "base",
            "swimlane_group_id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e",
            "type": "BASE",
            "tag": "base",
            "route_status": "ENABLE",
            "rule_match_mode": null,
            "project_id": "578ac30b81034b89a7255b3af26db9c9",
            "rules": null,
            "creator": "test_user",
            "create_time": 1726626094346,
            "update_time": 1726626094346,
            "instances": [
                {
                    "id": "5fd78836-301e-4750-bdc9-be8a9e43b19a",
                    "name": "weater-beta",
                    "version": "2024.0914.17114",
                    "application_id": "69993ce9-e468-3349-acb8-a30b85b17de5",
                    "application_name": "weathermap",
                    "status": "RUNNING",
                    "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067",
                    "runtime_stack": {
                        "type": "Java",
                        "name": "OpenJDK8",
                        "deploy_mode": "container",
                        "version": "1.3.8"
                    },
                    "replica": 1
                }
            ],
            "instance_count": 1,
            "weight": 100,
            "latest_opt": null,
            "release_plan_id": null
        }
    ],
    "swimlane_count": 1
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

请参考ServiceStage错误码

相关文档