文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 泳道/ 根据泳道ID关联组件 - AssociateComponentBasedOnTheLaneID
更新时间：2026-02-28 GMT+08:00
查看PDF
分享

根据泳道ID关联组件 - AssociateComponentBasedOnTheLaneID

功能介绍

此API用于根据泳道ID为泳道关联组件。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    servicestage::modifyLane

    write

    -

    -

    servicestage:app:modify

    -

URI

PUT /v3/{project_id}/cas/swimlane-group/{lane_group_id}/swimlane/{lane_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

lane_group_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

lane_id

是

String

参数解释：

泳道ID。获取方法，请参考获取泳道组下所有泳道 - ObtainAllLanesInLaneGroup。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及

取值范围：

application/json;charset=utf8

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

参数解释：

为泳道关联移除组件操作。

约束限制：

不涉及

取值范围：

  • ADD：关联组件。
  • REMOVE：移除组件。

默认取值：

不涉及

instance_ids

是

Array of strings

参数解释：

组件实例列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应消息

表4 响应参数

参数

参数类型

描述

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时生效。请参考表5。

weight

Integer

参数解释：

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

取值范围：

0-100之间

instances

Array of objects

参数解释：

泳道中纳管的组件列表，请参考表6。

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

参数解释：

创建人。

取值范围：

不涉及
表5 rules

参数

参数类型

描述

type

String

参数解释：

灰度匹配规则类型。

取值范围：

HEADER：基于Header头进行匹配

key

String

参数解释：

键。

取值范围：

不涉及

value

String

参数解释：

值。

取值范围：

不涉及

condition

String

参数解释：

匹配条件。

取值范围：

  • EXACT：精确匹配。
  • PREFIX：前缀匹配。
  • REGEX：正则匹配。
表6 instances

参数

参数类型

描述

id

String

参数解释：

应用组件实例ID。

取值范围：

不涉及

name

String

参数解释：

应用组件实例名称。

取值范围：

不涉及

version

String

参数解释：

应用组件版本号。

取值范围：

不涉及

application_id

String

参数解释：

应用ID。

取值范围：

不涉及

component_id

String

参数解释：

组件ID。

取值范围：

不涉及

application_name

String

参数解释：

应用名称。

取值范围：

不涉及

replica

Integer

参数解释：

实例副本数。

取值范围：

不涉及

请求示例

为id为8f8a5b33-ee1f-4a70-b3a9-c1b179a69fd2的泳道关联id为887f99d7-4ce5-431d-924f-6a328cb05572的组件实例。

{
    "instance_ids": [
        "887f99d7-4ce5-431d-924f-6a328cb05572"
    ],
    "action": "ADD"
}

响应示例

{
    "id": "8f8a5b33-ee1f-4a70-b3a9-c1b179a69fd2",
    "name": "base",
    "swimlane_group_id": "5447f910-ab74-4d15-b2ab-dd0945900ce9",
    "type": "BASE",
    "tag": "base",
    "route_status": "ENABLE",
    "rule_match_mode": null,
    "project_id": "86a1f7b663b349e89071a3090d9d81f3",
    "rules": null,
    "creator": "test_user",
    "create_time": 1722848532908,
    "update_time": 1722848532908,
    "instances": [
        {
   
            "id": "887f99d7-4ce5-431d-924f-6a328cb05572",
            "name": "comp-uh59l7s2",
            "version": "1.0.0",
            "application_id": "70502782-4f93-4eda-af19-415bac2d12ae",
            "application_name": "app-apitest-1o6l",
            "replica": 0
        }
    ],
    "instance_count": 1,
    "weight": 100,
    "latest_opt": null,
    "release_plan_id": null
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

请参考ServiceStage错误码。

父主题： 泳道

相关文档