QueryAllSwimmingLaneGroup - Microservices Engine - Alibaba Cloud Documentation Center

Queries all lane groups.

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:QueryAllSwimmingLaneGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The name of the MSE namespace to query.	default
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	54973C90-F379-4372-9AA5-053A3F7****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The code is used only to synchronize with success.	200
ErrorCode	string	The error code.	mse-100-000
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The message that is returned for the request. If the request is successful, a success message is returned. If the request fails, an error message is returned.	The request was successfully processed.
DynamicMessage	string	The dynamic part in the error message.	The specified parameter is invalid.
Data	array	The data returned.	[{id:100,name:"test"}]
	object
Name	string	The name of a lane group.	swimmingGroup
UserId	string	The ID of the user to which the lane belongs.	12345
MessageQueueFilterSide	string	The side at which canary release for messaging is enabled.	Client
AppIds	string	The application IDs.	abcde@abcde,abcde@abcde
Namespace	string	The MSE namespace to which the lane belongs.	default
RecordCanaryDetail	boolean	Indicates whether to record the request details (metrics of end-to-end canary release).	false
Id	integer	The ID of the lane group.	123
EntryApp	string	The type of the ingress application and the ID of the ingress application.	mse:abcde@abcde
Region	string	The region ID.	cn-hangzhou
MessageQueueGrayEnable	boolean	Indicates whether canary release for messaging is enabled.	true
Paths	string	This parameter is deprecated
paths	string	This parameter is deprecated
CanaryModel	integer	The routing mode for end-to-end canary release: 0: routing based on request content 1: routing based on percentages
canaryModel	integer	The routing mode for end-to-end canary release: 0: routing based on request content 1: routing based on percentages
SwimVersion	integer	The canary version. Valid values: 0 and 2. Recommended value: 2.
swimVersion	integer	The canary version. Valid values: 0 and 2. Recommended value: 2.

Examples

Success response

JSON format

{
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": [
    {
      "Name": "swimmingGroup",
      "UserId": "12345",
      "MessageQueueFilterSide": "Client",
      "AppIds": "abcde@abcde,abcde@abcde",
      "Namespace": "default",
      "RecordCanaryDetail": false,
      "Id": 123,
      "EntryApp": "mse:abcde@abcde",
      "Region": "cn-hangzhou",
      "MessageQueueGrayEnable": true,
      "Paths": "",
      "paths": "",
      "CanaryModel": 0,
      "canaryModel": 0,
      "SwimVersion": 0,
      "swimVersion": 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.