ListSwimmingLaneGatewayRoutes API Overview - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Lists the gateway routes that can be associated with a swimming lane.

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

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The ID of the namespace.	cn-beijing:test
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-277c0727535f4aae917e48de0f******

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned for the request. If the request is successful, success is returned. If the request fails, an error message is returned.	success
TraceId	string	The trace ID of the request.	ac1a0b2215622246421415014e****
Data	array<object>	The list of gateway routes.
	array<object>	The details of a gateway route.
RouteId	integer	The route ID.	16933
RouteName	string	The route name.	test-route
RoutePredicate	object	The routing rule.
PathPredicate	object	The path matching rule.
Path	string	The route path.	/Path
Type	string	The type of the rule.	Header
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section of this topic.
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: Indicates a client error. 5xx: Indicates a server error.	200
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "Data": [
    {
      "RouteId": 16933,
      "RouteName": "test-route",
      "RoutePredicate": {
        "PathPredicate": {
          "Path": "/Path",
          "Type": "Header\n"
        }
      }
    }
  ],
  "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.