CreateOrUpdateSwimmingLaneGroup - Microservices Engine - Alibaba Cloud Documentation Center

Creates or updates a lane group for an end-to-end canary release.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:CreateOrUpdateSwimmingLaneGroup

update

*GovernanceNamespace

acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region.	cn-shanghai
Namespace	string	No	The name of the MSE namespace.	default
Id	integer	No	The ID of the lane group. If you set this parameter to -1, a lane group is created. If you set this parameter to a value greater than 0, the specified lane group is modified.	1
Name	string	Yes	The name of the lane group.	group1
Status	integer	No	Specifies whether the lane group is enabled. A value of 0 indicates that the lane group is disabled. A value of 1 indicates that the lane group is enabled.	0
EntryApp	string	No	The entry application. The value is in the Source:ID format. Examples: mse:${MSE application ID} mse-gw:${MSE cloud-native gateway ID} apig:${cloud-native API Gateway ID}	mse-gw:gw-2b1407e050f1446xxxcd2a65fd9xxxx
AppIds	string	No	The IDs of applications. Separate multiple application IDs with commas (,).	xxxxn1po62@492b8f98d4bxxxx,xxxxn1po62@2d8f5d1b7f2xxxx
MessageQueueGrayEnable	boolean	No	Specifies whether to enable canary release for messages.	true
MessageQueueFilterSide	string	No	The side for message filtering in a canary release.	Server
DbGrayEnable	boolean	No	This parameter is deprecated. Specifies whether to enable canary release for databases.	true
RecordCanaryDetail	boolean	No	Specifies whether to record the details of canary release requests.	false
Paths	array	No	This parameter is deprecated. This parameter is used when a Java gateway is the entry application.
	string	No	This parameter is deprecated. The path.	a
RouteIds	array	No	The list of route IDs. If a cloud-native gateway is used as the entry application, you must call this operation to pass the list of route IDs for the cloud-native gateway before you create a lane for the lane group.
	integer	No	The route ID.	111
CanaryModel	integer	No	The canary release mode. 0: Content-based routing 1: Proportional routing	1
SwimVersion	integer	No	The version of the end-to-end canary release. Valid values: 0 and 2. A value of 0 is not recommended because you must specify a route. A value of 2 is recommended because you do not need to specify a route.	2
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	EE5C32A1-BC0E-4B79-817C-103E4EDF****
Success	boolean	Indicates whether the request was successful. Valid values: `true` and `false`. true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code.	Success
Message	string	The returned message.	请求处理成功
Data	object	The returned data.	{}
Name	string	The application name.	example-app
DbGrayEnable	string	Indicates whether canary release is enabled for databases.	true
UserId	string	The ID of the user to which the application belongs.	12345
MessageQueueFilterSide	string	The side for message filtering in a canary release.	Client
AppIds	string	A list of application IDs, separated by commas (,).	abcd1@abcde123,abcd1@abcde124
Namespace	string	The name of the MSE namespace.	prod
RecordCanaryDetail	boolean	Indicates whether the details of canary release requests are recorded.	true
Id	integer	The ID of the lane group.	2047
EntryApp	string	The entry application.	mse:abcd1@a2345
Region	string	The region where the application resides.	cn-hangzhou
MessageQueueGrayEnable	boolean	Indicates whether canary release is enabled for messages.	true
paths	string	This parameter is deprecated. If a Java gateway is the entry application, this parameter specifies a list of paths.	["/a"]
Paths	string	This parameter is deprecated. If a Java gateway is the entry application, this parameter specifies a list of paths.	["/a"]
canaryModel	integer	The canary release mode. 0: Content-based routing 1: Proportional routing	0
CanaryModel	integer	The canary release mode. 0: Content-based routing 1: Proportional routing	0

Examples

Success response

JSON format

{
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "ErrorCode": "Success",
  "Message": "请求处理成功\n",
  "Data": {
    "Name": "example-app",
    "DbGrayEnable": "true",
    "UserId": "12345",
    "MessageQueueFilterSide": "Client",
    "AppIds": "abcd1@abcde123,abcd1@abcde124",
    "Namespace": "prod",
    "RecordCanaryDetail": true,
    "Id": 2047,
    "EntryApp": "mse:abcd1@a2345",
    "Region": "cn-hangzhou",
    "MessageQueueGrayEnable": true,
    "paths": "[\"/a\"]",
    "Paths": "[\"/a\"]",
    "canaryModel": 0,
    "CanaryModel": 0
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.