更新时间:2024-10-11 GMT+08:00
分享

获取泳道组下所有泳道

功能介绍

此API用于获取泳道组下所有泳道。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

lane_group_id

String

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

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

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

响应消息

表3 响应参数

参数

参数类型

描述

swimlanes

Array of objects

泳道列表,请参考表4

count

Integer

泳道列表数量。

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

weight

Integer

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

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

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:正则匹配。

请求示例

响应示例

{
	"swimlanes" : [
		{
			"id" : "9974a8b3-cbd7-4084-bac9-194f7d5ba3da",
			"name" : "gray",
			"swimlane_group_id" : "b76dad96-66cf-4ae7-aa55-11b6d630e777",
			"type" : "GRAY",
			"tag" : "gray",
			"weight" : 0,
			"route_status" : "DISABLED",
			"rule_match_mode" : null,
			"project_id" : "4008a952b3f44b5a919c9a48d90811f3",
			"rules" : null,
			"creator" : "test_user",
			"create_time" : 1722928561358,
			"update_time" : 1722928561358
		}
	],
	"count" : 1
}

状态码

状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码

相关文档