ListGatewayAuth - Microservices Engine

取得閘道驗證清單。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:ListGatewayAuth

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	頁碼。	1
PageSize	integer	否	每頁顯示的執行個體數量。	10
OrderItem	string	否	尚未開放使用。	{}
DescSort	boolean	否	排序。	false
FilterParams	object	否	篩選條件，請參考範例。
Name	string	否	參數名稱。	rutain-test
Type	string	否	類型。	JWT
Status	boolean	否	啟用。	true
IsWhite	boolean	否	白名單模式。	true
GatewayUniqueId	string	否	閘道唯一識別碼 ID。	gw-5017305290e14centbrveca****
		否	傳回結果顯示的語言。取值：zh（預設值）：中文，en：英文。	zh

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	EC1EED4A-B147-597B-B949-FD3131AB4298
HttpStatusCode	integer	HTTP 狀態碼。	200
Message	string	錯誤訊息。	請求處理成功。
Code	integer	狀態碼。說明：200 表示成功。	200
Success	boolean	請求結果，取值如下： `true`：請求成功。 `false`：請求失敗。	true
Data	object	傳回資料。
TotalSize	integer	總筆數。	9
PageNumber	integer	頁數。	1
PageSize	integer	每頁筆數。	10
Result	array<object>	傳回結果。
	array<object>	傳回結果。
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

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。