ListGatewayAuth - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves the list of gateway authentication rules.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of instances displayed per page.	10
OrderItem	string	No	Not yet available for use.	{}
DescSort	boolean	No	The sort order.	false
FilterParams	object	No	The filter conditions. Refer to the example.
Name	string	No	The parameter name.	rutain-test
Type	string	No	The type.	JWT
Status	boolean	No	The enabled status.	true
IsWhite	boolean	No	The whitelist mode.	true
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-5017305290e14centbrveca****
		No	The language of the returned results. Valid values: zh (default): Chinese, en: English.	zh

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	EC1EED4A-B147-597B-B949-FD3131AB4298
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	The request was successfully processed.
Code	integer	The status code. A value of 200 indicates success.	200
Success	boolean	The request result. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
TotalSize	integer	The total number of entries.	9
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Result	array<object>	The returned results.
	array<object>	The returned results.
Id	integer		549
Name	string		test
GatewayUniqueId	string		gw-e2d226bba4b2445c9e29fa7f8216****
GatewayId	integer		1
Type	string		JWT
Issuer	string		https://example.com/auth
Jwks	string		{\"keys\":[{\"kty\":\"oct\",\"k\":\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\",\"alg\":\"HS256\"}]}
TokenPosition	string		HEADER
TokenName	string		Authorization
TokenNamePrefix	string		Bearer
GmtCreate	string		2021-09-13 19:24:23
GmtModified	string		2021-09-13 19:24:23
TokenPass	boolean		true
IsWhite	boolean		true
Status	boolean		true
RedirectUrl	string		http://test.com/oauth2/callback
ClientId	string		app_mnvxaavggw7hcdcnr6usi6***
ClientSecret	string		CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
CookieDomain	string		test.com
ScopesList	string		["openid"]
LoginUrl	string		https://daxxxxcn.aliyunidaas.com/
Sub	string		example-app
ExternalAuthZ	object
ServiceId	integer		45186
PrefixPath	string		/auth
TokenKey	string		Authorization
AllowRequestHeaders	array
	string		x-req
AllowUpstreamHeaders	array
	string		x-resp
Timeout	integer		30
WithRequestBody	boolean		true
WithRematchRoute	boolean		true
BodyMaxBytes	integer		1024
IsRestrict	boolean		true
Service	object
Name	string		updatetime
SourceType	string		MSE
GroupName	string		com.mse.console.test.3YXO
Namespace	string		default
AuthResourceMode	integer		0

Examples

Success response

JSON format

{
  "RequestId": "EC1EED4A-B147-597B-B949-FD3131AB4298",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 549,
        "Name": "test",
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "GatewayId": 1,
        "Type": "JWT",
        "Issuer": "https://example.com/auth",
        "Jwks": "{\\\"keys\\\":[{\\\"kty\\\":\\\"oct\\\",\\\"k\\\":\\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\\",\\\"alg\\\":\\\"HS256\\\"}]}",
        "TokenPosition": "HEADER",
        "TokenName": "Authorization",
        "TokenNamePrefix": "Bearer",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "TokenPass": true,
        "IsWhite": true,
        "Status": true,
        "RedirectUrl": "http://test.com/oauth2/callback",
        "ClientId": "app_mnvxaavggw7hcdcnr6usi6***",
        "ClientSecret": "CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****",
        "CookieDomain": "test.com",
        "ScopesList": "[\"openid\"]",
        "LoginUrl": "\t\nhttps://daxxxxcn.aliyunidaas.com/",
        "Sub": "example-app",
        "ExternalAuthZ": {
          "ServiceId": 45186,
          "PrefixPath": "/auth",
          "TokenKey": "Authorization",
          "AllowRequestHeaders": [
            "x-req"
          ],
          "AllowUpstreamHeaders": [
            "x-resp"
          ],
          "Timeout": 30,
          "WithRequestBody": true,
          "WithRematchRoute": true,
          "BodyMaxBytes": 1024,
          "IsRestrict": true,
          "Service": {
            "Name": "updatetime",
            "SourceType": "MSE",
            "GroupName": "com.mse.console.test.3YXO",
            "Namespace": "default"
          }
        },
        "AuthResourceMode": 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.