创建泳道组 - CreateLaneGroup
功能介绍
此API用于创建泳道组。
泳道组是一组泳道的集合,用于区分不同的组织或场景。同一个项目下,最多支持创建300个泳道组。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage::createLaneGroup
write
-
-
servicestage:app:create
-
URI
POST /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获取方式,请参考认证鉴权。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 是 | String | 参数解释: 泳道组的名称。 取值范围: 由大小写英文字母、数字、中划线(-)、下划线(_)组成,并以大小写英文字母开头,大小写英文字母或者数字结尾,长度为2~64个字符。 默认取值: 不涉及 |
gateways | 否 | Array of objects | 参数解释: 泳道组关联网关列表,全链路流量的入口。请参考表4。 |
description | 否 | String | 参数解释: 泳道组的描述信息。 取值范围: 最大长度为128个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
engine_id | 是 | String | 参数解释: 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 取值范围: 不涉及 默认取值: 不涉及 |
id | 是 | String | 参数解释: 网关ID。 取值范围: 不涉及 默认取值: 不涉及 |
name | 否 | String | 参数解释: 网关名称。 取值范围: 不涉及 默认取值: 不涉及 |
target_services | 是 | Array of objects | 参数解释: 目标服务列表,对应于网关服务管理中的服务。请参考表5。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
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 | 参数解释: 引擎类型。 取值范围:
默认取值: 不涉及 |
响应消息
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释: 泳道组的名称。 取值范围: 不涉及 |
gateways | Array of objects | 参数解释: 流量网关入口,请参考表7。 |
description | String | 参数解释: 泳道组的描述。 取值范围: 不涉及 |
gray_release_type | String | 参数解释: 灰度发布类型。 取值范围:
|
id | String | 参数解释: 泳道组的ID。 取值范围: 不涉及 |
gateway_engine_ids | Array of strings | 参数解释: 网关ID列表。 取值范围: 不涉及 |
creator | String | 参数解释: 创建者。 取值范围: 不涉及 |
create_time | String | 参数解释: 创建时间。 取值范围: 不涉及 |
update_time | String | 参数解释: 更新时间 取值范围: 不涉及 |
project_id | String | 参数解释: 租户项目ID。 取值范围: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
engine_id | String | 参数解释: 目标服务引擎ID,对应于目标服务对应的服务来源所用的引擎ID。 取值范围: 不涉及 |
id | String | 参数解释: 网关ID。 取值范围: 不涉及 |
name | String | 参数解释: 网关名称。 取值范围: 不涉及 |
target_services | Array of objects | 参数解释: 目标服务列表,对应于网关服务管理中的服务。请参考表8。 |
参数 | 参数类型 | 描述 |
|---|---|---|
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 | 参数解释: 引擎类型。 取值范围:
|
请求示例
创建一个名为test、描述信息为test的泳道组。该泳道组绑定了名为microGateway-cy8bhr的应用网关作为流量入口网关,通过该应用网关转发流量的目标服务为接入了ServiceComb引擎的所在环境为空、所属应用名称为demo-java-chassis-cse-v2的名为provider的微服务。
{
"name": "test",
"description": "test",
"gateways": [
{
"id": "71949725-9c8f-483a-a05f-74d33ff1613e",
"name": "microGateway-cy8bhr",
"engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067",
"target_services": [
{
"id": "8177d237-b912-4167-a90d-33c603610d0b",
"host": "provider..demo-java-chassis-cse-v2.servicecomb",
"name": "provider",
"engine_type": "servicecomb",
"engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067"
}
]
}
]
} 响应示例
{
"gateways": [
{
"id": "71949725-9c8f-483a-a05f-74d33ff1613e",
"name": "microGateway-cy8bhr",
"target_services": [
{
"id": "8177d237-b912-4167-a90d-33c603610d0b",
"host": "provider..demo-java-chassis-cse-v2.servicecomb",
"name": "provider",
"engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067",
"engine_type": "servicecomb"
}
],
"engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067"
}
],
"id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e",
"name": "test",
"gray_release_type": "WEIGHT",
"description": "test",
"project_id": "578ac30b81034b89a7255b3af26db9c9",
"creator": "test_user",
"create_time": 1726623793113,
"update_time": 1726623793113,
"gateway_engine_ids": [
"d68a5ca7-b5b6-4917-a464-0adef94b8067"
]
} 状态码
状态码 | 描述 |
|---|---|
200 | 操作成功 |
400 | 错误的请求 |
404 | 请求对象不存在 |
500 | 内部错误 |
错误码
请参考ServiceStage错误码。

