All Products
Search
Document Center

Microservices Engine:CreateOrUpdateSwimmingLane

Last Updated:Aug 12, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:CreateOrUpdateSwimmingLanecreate
  • GovernanceNamespace
    acs:mse:{#regionId}:{#accountId}:namespace/{#Namespace}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-beijing
IdlongNo

The ID of the primary key. The value -1 indicates a request that is used to create a lane. A value greater than 0 indicates a request that is used to modify a lane.

-1
NamestringYes

The name of the lane.

Test lane
TagstringNo

The tag.

gray
EnablebooleanNo

Specifies whether to enable the lane.

true
GroupIdlongNo

The language of the response. Valid values:****

  • zh-CN: Chinese
  • en-US: English
Note Default value: zh-CN.
115
EnableRulesbooleanNo

Specifies whether to configure a routing rule for the lane. If an Ingress gateway is used, this parameter is not required.

false
EntryRulesarray<object>No

The lane.

objectNo

The information about the routing rule for the ingress application.

PathsarrayNo

The paths.

stringNo

The path.

/
ConditionstringNo

Specifies how RESTful items are combined into the final condition.

""
RestItemsarray<object>No

The matching list.

objectNo

The object of the rule.

TypestringNo

The matching type.

header
NamestringNo

The name.

""
OperatorstringNo

The operator.

mod
NameListarrayNo

The matching list.

stringNo

The name.

A081
DatumstringNo

The value.

.params[0]
CondstringNo

The matching character.

=
DivisorintegerNo

The divisor.

10
RemainderintegerNo

The remainder.

3
RateintegerNo

The percentage.

10
ValuestringNo

The value.

""
PriorityintegerNo

The priority.

1
EntryRuledeprecatedstringNo

The JSON string.

{}
GatewaySwimmingLaneRouteJsonobjectNo

The information about the routing rule for the gateway. This parameter is required when a cloud-native gateway is used as the ingress.

GatewayIdlongNo

The ID of the gateway.

1
GatewayUniqueIdstringNo

The unique ID of the gateway.

gw-84efde2ee1464260bdb17a5b****
RouteIdListarrayNo

The route IDs.

longNo

The route ID.

1
Conditionsarray<object>No

The matching conditions.

objectNo
NamestringNo

The name of the parameter.

name
ValuestringNo

The value of the parameter.

xiaoming
TypestringNo

The type of the parameter. Valid values:

  • header
  • param
header
CondstringNo

The matching condition. Valid values:

  • PRE: prefix matching
  • EQUAL: exact matching
  • ERGULAR: regular expression matching
PRE
AcceptLanguagestringNo

The language of the response. Valid values: zh and en. Default value: zh. The value zh indicates Chinese, and the value en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object

RestResult

RequestIdstring

The ID of the request.

EE5C32A1-BC0E-4B79-817C-103E4EDF****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codeinteger

The status code. The value 200 is returned if the request is successful.

200
ErrorCodestring

The error code returned if the request failed.

mse-100-000
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

The request was successfully processed.
Dataany

The details of the data.

{}

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request was successfully processed.\n",
  "Data": "{}"
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-29The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-03-14The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-10-26The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-08-16The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-06-08The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-05-06The response structure of the API has changedView Change Details
2023-04-25The response structure of the API has changedView Change Details
2023-04-20API Description Update. The request parameters of the API has changedView Change Details
2023-03-30API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details