Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Lane/ Controlling the Lane Route Switch Based on the Lane ID
Updated on 2024-10-16 GMT+08:00

Controlling the Lane Route Switch Based on the Lane ID

Function

This API is used to control the lane route switch based on the lane ID.

URI

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

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.

lane_id

Yes

String

Lane ID. See Obtaining All Lanes in a Lane Group.

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

route_status

Yes

String

Route status.

  • ENABLE
  • DISABLED

Response

None

Example Request

Disable the lane route.

{
  "route_status": "DISABLED"
}

Example Response

None

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.