获取所有泳道组
功能介绍
此API用于获取所有已经创建的泳道组。
URI
GET /v3/{project_id}/cas/swimlane-group
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
泳道组总数。 |
swimlaneGroups |
Array of objects |
泳道组列表,请参考表4。 |
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
泳道组的描述。 |
gray_release_type |
String |
灰度发布类型。
|
gateways |
Array of objects |
流量网关入口,请参考表5。 |
name |
String |
泳道组的名称。 |
id |
String |
泳道组的ID。 |
gateway_engine_ids |
Array of String |
网关ID列表。 |
creator |
String |
创建者。 |
create_time |
String |
创建时间。 |
update_time |
String |
更新时间 |
project_id |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
engine_id |
String |
引擎ID。 |
id |
String |
网关ID。 |
name |
String |
网关名称。 |
target_services |
Array of objects |
目标服务列表。请参考表6。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
引擎类型。
|
请求示例
无
响应示例
{ "swimlaneGroups": [ { "gateways": [ { "id": "6b635e85-d0bc-4c78-923f-c7b6a0ab095f", "name": "microGateway-yzh", "target_services": [ { "id": "29425ac7-ced5-4d2a-b734-bd6e5e35561b", "host": "dsads..dsadas.servicecomb", "name": "dsads", "engine_id": null, "engine_type": null } ], "engine_id": "3b482b67-2374-4f6a-9f77-850028e07474" } ], "id": "529928ed-43ff-4c3c-8c85-5aa68febf811", "name": "lk2", "gray_release_type": "WEIGHT", "description": "", "project_id": "79c4086f5f3a4e34a92601dfc64b1e8c", "creator": "sunhaidong", "create_time": 1702628549179, "update_time": 1702628549179, "gateway_engine_ids": [ "3b482b67-2374-4f6a-9f77-850028e07474" ] } ], "count": 1 }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功 |
400 |
错误的请求 |
404 |
请求对象不存在 |
500 |
内部错误 |
错误码
请参考ServiceStage错误码。