QuerySwimmingLaneById - Microservices Engine - Alibaba Cloud Documentation Center

Queries swimming lane information by swimming lane ID.

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 support 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:QuerySwimmingLaneById

get

*GovernanceNamespace

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

None

Request parameters

Parameter	Type	Required	Description	Example
LaneId	integer	Yes	The swimming lane ID.	250
Namespace	string	No	The name of the MSE namespace.	default
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh

Response parameters

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	69AD2AA7-DB47-449B-941B-B14409DF****
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	The error code.	mse-100-000
Message	string	The message.	The request was successfully processed.
Data	object	The returned data.	{id:102,name:"test"}
name	string	The swimming lane name.	test
id	integer	The swimming lane ID.	1
tag	string	The tag corresponding to the swimming lane.	gray
status	integer	The swimming lane status.	1
enable	boolean	The swimming lane switch.	true
regionId	string	The region ID.	cn-shanghai
groupId	integer	The swimming lane group ID.	8
entryRule	string	The entry application rule.	{}
entryRules	array	The details of the entry application rules.
	object	The entry application rule.
paths	array	The list of paths.
	string	The path.	/
path	string	The path.	/
condition	string	The condition.	AND
restItems	array	The Restful matching rules.
	object	The Restful matching rule.
type	string	The matching type.	cookie
name	string	The name.	11111
operator	string	The filter operator.	rawvalue
nameList	array	The names.
	string	The name.	test
datum	string	The number.	x
cond	string	The matching character.	==
divisor	integer	The divisor.	10
remainder	integer	The remainder.	10
rate	integer	The percentage.	30
value	string	The value.	hello
enableRules	boolean	Specifies whether to enable the rule. Valid values:	true
gmtCreate	string	Rule Created At	1683598484000
gmtModified	string	Rule Modified At	1683598484000
gatewaySwimmingLaneRouteJson	string	The MSE gateway routing rule.	{}
PathIndependentPercentageEnable	boolean	This parameter is discontinued. This parameter is used to specify whether to enable grayscale by path when Java gateway is used as the entry for the swimming lane group.	false

Examples

Success response

JSON format

{
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Message": "The request was successfully processed.\n",
  "Data": {
    "name": "test",
    "id": 1,
    "tag": "gray",
    "status": 1,
    "enable": true,
    "regionId": "cn-shanghai",
    "groupId": 8,
    "entryRule": "{}",
    "entryRules": [
      {
        "paths": [
          "/"
        ],
        "path": "/",
        "condition": "AND",
        "restItems": [
          {
            "type": "cookie",
            "name": "11111",
            "operator": "rawvalue",
            "nameList": [
              "test"
            ],
            "datum": "x",
            "cond": "==",
            "divisor": 10,
            "remainder": 10,
            "rate": 30,
            "value": "hello"
          }
        ]
      }
    ],
    "enableRules": true,
    "gmtCreate": "1683598484000",
    "gmtModified": "1683598484000",
    "gatewaySwimmingLaneRouteJson": "{}",
    "PathIndependentPercentageEnable": false
  }
}

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.