文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 泳道/ 根据泳道ID批量操作泳道组件 - PerformOperationsOnComponentsInLaneBasedOnTheLaneID
更新时间：2025-11-20 GMT+08:00
查看PDF
分享

根据泳道ID批量操作泳道组件 - PerformOperationsOnComponentsInLaneBasedOnTheLaneID

功能介绍

此API用于泳道ID批量操作泳道组件。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    servicestage::modifyLane

    write

    -

    -

    -

    -

URI

PUT /v3/{project_id}/cas/swimlane-group/{lane_group_id}/swimlane/{lane_id}/component-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

泳道组件批量操作，当前支持delete、add操作。

instance_ids

是

List<String>

组件实例ID集合。

响应消息

表4 响应参数

参数

参数类型

描述

id

String

泳道ID。

name

String

泳道名称。

swimlane_group_id

String

泳道组ID。

type

String

泳道的类型。当泳道组下没有泳道时，必须先创建基线泳道；当泳道组下已创建基线泳道时，只能创建灰度泳道。

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

tag

String

泳道的标签。

route_status

String

泳道路由状态。

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

project_id

String

项目ID。

creator

String

创建人。

create_time

Integer

创建时间。

update_time

Integer

更新时间。

instances

Array of objects

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

instance_count

Integer

泳道中纳管的组件数量。

weight

Integer

泳道流量权重，范围在0-100之间。当泳道组灰度类型为基于流量时生效。
表5 instances

参数

参数类型

描述

component_id

String

组件ID。

environment_id

String

环境ID。

id

String

应用组件实例ID。

name

String

应用组件实例名称。

version

String

应用组件版本号。

application_id

String

应用ID。

application_name

String

应用名称。

engine_id

String

组件关联引擎ID。

replica

Integer

实例副本数。

请求示例

将ID为30f88521-fa43-42ff-aaec-9cac4259fb16的组件实例从泳道中删除。

{
	"instance_ids": [
		"b647acf3-3193-4d17-80bd-277586b5bb94",
		"8071aaef-e506-47c7-a6f0-1b802ade24c7"
	],
	"action": "ADD"
}

响应示例

{
    "id": "0fb3e224-5410-4434-a0cd-fe8602f1b06b",
    "name": "test",
    "swimlane_group_id": "c0a217d6-8716-4ec9-8dd5-24d06e3d042b",
    "type": "BASE",
    "tag": "base",
    "route_status": "ENABLE",
    "project_id": "ca8d639749d94484ab6dc7da1573e7f4",
    "creator": "test",
    "create_time": 1736150429130,
    "update_time": 1736150429130,
    "instances": [
        {
            "component_id": "195f434d-0a1f-4f62-ab42-87b1dd62a41c",
            "environment_id": "15af27b1-eba2-4474-88db-bbe2cef0d2e8",
            "id": "3200cabb-8384-4852-9d45-44aee56641ff",
            "name": "unit-provider",
            "version": "2025.0509.11376",
            "application_id": "074111af-2321-407b-8025-f75abf2cd898",
            "application_name": "app-hq",
            "engine_id": "cbf81c4e-400b-4b1c-a904-6306f46465dd",
            "replica": 0
        }
    ],
    "instance_count": 1,
    "weight": 50
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

请参考ServiceStage错误码。

父主题： 泳道

相关文档