根据微服务引擎ID获取所有泳道 - ObtainAllLanesBasedOnTheMicroserviceEngineID
功能介绍
此API用于根据微服务引擎ID获取所有泳道。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage::listLaneGroup
list
-
-
servicestage:app:list
-
URI
GET /v3/{project_id}/cas/swimlane
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户项目ID。获取方法,请参考获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
engine_id | 是 | String | 参数解释: 微服务引擎ID。获取方法,请参考查询微服务引擎列表 - QueryMicroserviceEngineList。 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及 取值范围: application/json;charset=utf8 默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应消息
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 泳道总数。 取值范围: 不涉及 |
swimlanes | Array of objects | 参数解释: 泳道列表,请参考表5。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 泳道ID。 取值范围: 不涉及 |
name | String | 参数解释: 泳道名称。 取值范围: 不涉及 |
swimlane_group_id | String | 参数解释: 所属的泳道组ID。 取值范围: 不涉及 |
type | String | 参数解释: 泳道类型。 取值范围:
|
tag | String | 参数解释: 泳道标签,根据标签来控制流量的走向。 取值范围: 不涉及 |
route_status | String | 参数解释: 泳道路由状态。 取值范围:
|
rule_match_mode | String | 参数解释: 路由规则匹配模式。当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。 取值范围:
|
rules | Array of objects | 参数解释: 路由规则。当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。请参考表6。 |
weight | Integer | 参数解释: 泳道流量权重。 当泳道组灰度类型为基于流量,即gray_release_type为WEIGHT时生效。 取值范围: 0-100之间 |
project_id | String | 参数解释: 项目ID。 取值范围: 不涉及 |
create_time | Integer | 参数解释: 创建时间。 取值范围: 不涉及 |
update_time | Integer | 参数解释: 更新时间。 取值范围: 不涉及 |
creator | String | 参数解释: 创建人。 取值范围: 不涉及 |
swimlane_group | Object | 参数解释: 泳道组信息,请参考表表7。 |
参数 | 参数类型 | 描述 |
|---|---|---|
type | String | 参数解释: 灰度匹配规则类型。 取值范围: HEADER:基于Header头进行匹配 |
key | String | 参数解释: 键。 取值范围: 不涉及 |
value | String | 参数解释: 值。 取值范围: 不涉及 |
condition | String | 参数解释: 匹配条件。 取值范围:
|
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 泳道组ID。 取值范围: 不涉及 |
name | String | 参数解释: 泳道组名称。 取值范围: 不涉及 |
gray_release_type | String | 参数解释: 泳道组灰度策略。 取值范围:
|
description | String | 参数解释: 泳道组描述。 取值范围: 不涉及 |
gateways | Array of objects | 参数解释: 流量网关入口,请参考表8。 |
参数 | 参数类型 | 描述 |
|---|---|---|
engine_id | String | 参数解释: 引擎ID。 取值范围: 不涉及 |
id | String | 参数解释: 网关ID。 取值范围: 不涉及 |
name | String | 参数解释: 网关名称。 取值范围: 不涉及 |
target_services | Array of objects | 参数解释: 目标服务列表,请参考表9。 |
参数 | 参数类型 | 描述 |
|---|---|---|
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 | 参数解释: 引擎类型。 取值范围:
|
请求示例
无
响应示例
{
"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": {
"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错误码。

