All Products
Search
Document Center

Serverless App Engine:ListSwimmingLaneGatewayRoutes

Last Updated:Dec 17, 2025

Query the gateway routes that are available for a lane

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
sae:ListSwimmingLaneGatewayRouteslist
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
NamespaceIdstringNo

The ID of the namespace.

cn-beijing:test
GatewayUniqueIdstringNo

The unique ID of the gateway.

gw-277c0727535f4aae917e48de0f******

Response parameters

ParameterTypeDescriptionExample
object

The returned information.

RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

Additional information. Valid values:

  • The error message returned because the request is normal and success is returned.
  • If the request is abnormal, the specific exception error code is returned.
success
TraceIdstring

The ID of the trace. This parameter is used to query the exact call information.

ac1a0b2215622246421415014e****
Dataarray<object>

Responses.

dataobject

Details.

RouteIdlong

The ID of the route.

16933
RouteNamestring

The name of the route.

test-route
RoutePredicateobject

The routing rule.

PathPredicateobject

The path matching rule.

Pathstring

The route URL.

/Path
Typestring

The type of the protection rule.

Header
ErrorCodestring

The status code. Value values:

  • If the request was successful, ErrorCode is not returned.
  • If the request failed, ErrorCode is returned. For more information, see Error codes in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the request was successful. Valid values: Valid values:

  • true: The configurations were obtained.
  • false: The configurations failed to be queried.
true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameter.NotEmptyYou must specify the parameter %s.-
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.-
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s-
400MseGatewayRule.CreateFailedCreate MSE Gateway rule failed.Failed to create an MSE microservices gateway route.
400InternalApiErrorAn exception occurred when calling mse:%s, error message: %s.-

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