文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 泳道组/ 创建泳道组
更新时间：2024-10-16 GMT+08:00
查看PDF
分享

创建泳道组

功能介绍

此API用于创建泳道组。

泳道组是一组泳道的集合，用于区分不同的组织或场景。同一个项目下，最多支持创建300个泳道组。

URI

POST /v3/{project_id}/cas/swimlane-group

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

name

是

String

泳道组的名称。

由大小写英文字母、数字、中划线（-）、下划线（_）组成，并以大小写英文字母开头，大小写英文字母或者数字结尾，长度为2~64个字符。

gateways

否

Array of objects

泳道组关联网关列表，全链路流量的入口。请参考表4。

description

否

String

泳道组的描述信息。

最大长度为128个字符。
表4 gateways

参数

是否必选

参数类型

描述

engine_id

是

String

目标服务引擎ID，对应于目标服务对应的服务来源所用的引擎ID。

id

是

String

网关ID。

name

否

String

网关名称。

target_services

是

Array of objects

目标服务列表，对应于网关服务管理中的服务。请参考表5。
表5 target_services

参数

是否必选

参数类型

描述

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

引擎类型。

  • servicecomb：ServiceComb引擎。
  • nacos：注册配置中心。

响应消息

表6 响应参数

参数

参数类型

描述

name

String

泳道组的名称。

gateways

Array of objects

流量网关入口，请参考表7。

description

String

泳道组的描述。

gray_release_type

String

灰度发布类型。

  • WEIGHT：基于流量比例进行全链路灰度。
  • CONTENT：基于内容进行全链路灰度。

id

String

泳道组的ID。

gateway_engine_ids

Array of String

网关ID列表。

creator

String

创建者。

create_time

String

创建时间。

update_time

String

更新时间

project_id

String

租户项目ID。
表7 gateways

参数

参数类型

描述

engine_id

String

目标服务引擎ID，对应于目标服务对应的服务来源所用的引擎ID。

id

String

网关ID。

name

String

网关名称。

target_services

Array of objects

目标服务列表，对应于网关服务管理中的服务。请参考表8。
表8 target_services

参数

参数类型

描述

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

引擎类型。

  • servicecomb：ServiceComb引擎。
  • nacos：注册配置中心。

请求示例

创建一个名为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

内部错误

错误码

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

父主题： 泳道组