All Products
Search
Document Center

Microservices Engine:ListGatewayRouteOnAuth

Last Updated:Aug 12, 2024

Queries a list of routes for which authentication is enabled.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
mse:ListGatewayRouteOnAuthlist
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-c9bc5afd61014165bd58f621b491****
TypestringYes

The authentication method. Valid values:

  • JWT
JWT
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

58E06A0A-BD2C-47A0-99C2-B100F353****
HttpStatusCodeinteger

The HTTP status code.

200
Messagestring

The returned message.

The request is successfully processed.
Codeinteger

The response code.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Dataarray<object>

The details of the data.

object

The data of the node.

Idinteger

The route ID.

12
Namestring

The name of the route.

ceshi
GatewayUniqueIdstring

The unique ID of the gateway.

gw-7ea3da97b96543e19f6c597c****
GatewayIdstring

The gateway ID.

399
RoutePredicatesobject

The information about route matching.

PathPredicatesobject

The information about route matching.

Pathstring

The path.

/api
Typestring

The matching type.

PRE
DomainIdlong

The domain ID.

235
DomainNamestring

The domain name.

123.com
DomainIdListarray

The domain IDs.

long

The domain ID.

1
DomainNameListarray

The domain names.

string

The domain name.

test.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "58E06A0A-BD2C-47A0-99C2-B100F353****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 12,
      "Name": "ceshi",
      "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
      "GatewayId": "399",
      "RoutePredicates": {
        "PathPredicates": {
          "Path": "/api",
          "Type": "PRE"
        }
      },
      "DomainId": 235,
      "DomainName": "123.com",
      "DomainIdList": [
        1
      ],
      "DomainNameList": [
        "test.com"
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-08-24The internal configuration of the API is changed, but the call is not affectedView Change Details