ListAllSwimmingLaneGroups API Reference - SAE - Alibaba Cloud - Serverless App Engine

Returns a list of all swimlane 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

sae:ListAllSwimmingLaneGroups

list

*All Resource

*

None

Request syntax

GET /pop/v1/cas/gray/listSwimmingLaneGroups HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The namespace ID.	cn-beijing:test

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	The response message. success is returned if the request is successful. An error message is returned if the request fails.	success
TraceId	string	The trace ID that is used to query the details of a request.	ac1a0b2215622246421415014e****
Data	array<object>	The returned data.
	array<object>	The information about the swimming lane groups.
GroupId	integer	The ID of the swimming lane group.	110283
GroupName	string	The name of the swimming lane group.	mse-test
NamespaceId	string	The namespace ID.	cn-beijing:test
MseNamespaceId	string	The ID of the namespace to which the MSE instance belongs.	sae-ent
CanaryModel	integer	The canary release mode. 0: content-based routing 1: percentage-based routing	0
AppIds	array	The IDs of the applications that are associated with the swimming lane group.
	string	An application ID.	[ "1409e354-8b4c-4c53-ab35-f2765e****", "ef41218e-f96c-4d92-a5ed-1f6e83**", "52cc2015-265b-4cd6-8bb8-21ea4f****" ]
Apps	array<object>	The information about the applications.
	object	The details of an application.
AppId	string	The application ID.	f5aad0d0-3e56-44cd-8199-9887a0******
AppName	string	The application name.	test
MseAppId	string	The ID of the MSE instance.	mse-cn-53y49******
MseAppName	string	The name of the MSE instance.	demo
MseNamespaceId	string	The ID of the namespace to which the MSE instance belongs.	sae-ent
EntryAppType	string	The type of the ingress application. This parameter is equivalent to the gateway type. apig: API Gateway mse-gw: cloud-native gateway mse: Java service gateway	mse-gw
EntryAppId	string	The ID of the gateway.	bq4g5bumop@e05bd4328******
EntryApp	object	The ingress application.
AppId	string	The application ID.	09805e5d-9b8d-42cd-9442-03c498******
AppName	string	The application name.	test
AppType	string	The application type.	mse
MseAppId	string	The ID of the MSE instance.	mse-cn-53y49******
MseAppName	string	The name of the MSE instance.	test
MseNamespaceId	string	The ID of the namespace to which the MSE instance belongs.	sae-ent
SwimVersion	string	The version of the canary release. Valid values: 0 and 2. We recommend that you use 2.	2
ErrorCode	string	The error code. This parameter is not returned if the request is successful. For a list of error codes, see the "Error codes" section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "Data": [
    {
      "GroupId": 110283,
      "GroupName": "mse-test",
      "NamespaceId": "cn-beijing:test",
      "MseNamespaceId": "sae-ent\n",
      "CanaryModel": 0,
      "AppIds": [
        "[\n        \"1409e354-8b4c-4c53-ab35-f2765e******\",\n        \"ef41218e-f96c-4d92-a5ed-1f6e83******\",\n        \"52cc2015-265b-4cd6-8bb8-21ea4f******\"\n      ]"
      ],
      "Apps": [
        {
          "AppId": "f5aad0d0-3e56-44cd-8199-9887a0******",
          "AppName": "test",
          "MseAppId": "mse-cn-53y49******",
          "MseAppName": "demo",
          "MseNamespaceId": "sae-ent"
        }
      ],
      "EntryAppType": "mse-gw",
      "EntryAppId": "bq4g5bumop@e05bd4328******",
      "EntryApp": {
        "AppId": "09805e5d-9b8d-42cd-9442-03c498******",
        "AppName": "test",
        "AppType": "mse",
        "MseAppId": "mse-cn-53y49******\n",
        "MseAppName": "test",
        "MseNamespaceId": "sae-ent"
      },
      "SwimVersion": "2"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	MseGatewayRule.CreateFailed	Create MSE Gateway rule failed.	Failed to create an MSE microservices gateway route.
400	InternalApiError	An exception occurred when calling mse:%s, error message: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.