Updated on 2024-10-16 GMT+08:00

Creating a Lane in a Lane Group

Function

This API is used to create a lane in a lane group.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

lane_group_id

Yes

String

Lane group ID. See Obtaining All Lane Groups.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Lane name.

The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), and underscores (_). It starts with a letter and ends with a letter or digit.

tag

Yes

String

Lane tag.

type

Yes

String

Lane type. If there is no lane in a lane group, you must create a baseline lane first. If a baseline lane has been created in a lane group, only dark launch lanes can be created.

  • BASE: baseline lane.
  • GRAY: dark launch lane.

Response

Table 4 Response parameters

Parameter

Type

Description

id

String

Lane ID.

name

String

Lane name.

swimlane_group_id

String

Lane group ID.

type

String

Lane type.

  • BASE: baseline lane.
  • GRAY: dark launch lane.

tag

String

Lane tag, which is used to control traffic routing.

route_status

String

Route status.

  • ENABLE
  • DISABLE

rule_match_mode

String

Mode of matching routing rules.

This parameter is valid when gray_release_type is set to CONTENT.

  • ALL: matches all rules.
  • ANY: matches any rule.

rules

Array of objects

Routing rules. This parameter is valid when gray_release_type is set to CONTENT. See Table 5.

weight

Integer

Lane traffic weight. Value range: 0–100. This parameter is valid when gray_release_type is set to WEIGHT.

project_id

String

Project ID.

create_time

Integer

Creation time.

update_time

Integer

Update time.

creator

String

Creator.

Table 5 rules

Parameter

Type

Description

type

String

Type of dark launch matching rule. Currently, only HEADER is supported, that is, matching by header.

key

String

Key.

value

String

Value.

condition

String

Match condition.

  • EXACT
  • PREFIX
  • REGEX

Example Request

Create a dark launch lane named gray in the lane group.

{
    "name": "gray",
    "type": "GRAY",
    "tag": "gray"
}

Example Response

{
    "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
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.