UpdateGatewayAuth - Microservices Engine

更新閘道驗證。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:UpdateGatewayAuth

update

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	驗證名稱。	test
Type	string	否	驗證類型： JWT OIDC IDaaS ExternalAuthZ（自建的驗證服務）	ExternalAuthZ
Issuer	string	否	驗證類型為 JWT/OIDC 時使用： JWT：表示 JWT claims 的 iss(issuer)，即簽發人。 OIDC：表示 OIDC claims 的 iss(issuer)，即簽發人。	test
Jwks	string	否	JWT 公鑰，支援 JSON 格式。	{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
TokenPosition	string	否	JWT Token 類型： HEADER：透過標頭傳輸要校驗的 Token 參數資訊，預設是以 Bearer 為前綴放在 Authorization 標頭中，例如：Authorization: Bearer token。	HEADER
TokenName	string	否	JWT Token 儲存的位置。要校驗的 Token 參數資訊，預設是以 Bearer 為前綴放在 Authorization 標頭中，例如：`Authorization: Bearer token`。	Authorization
TokenNamePrefix	string	否	JWT Token 的前綴。要校驗的 Token 參數資訊，預設是以 Bearer 為前綴放在 Authorization 標頭中，例如：`Authorization: Bearer token`。	Bearer
TokenPass	boolean	否	是否透傳 Token。	true
Status	boolean	否	啟用狀態。未啟用：false 啟用：true	true
Id	integer	否	驗證規則 ID。	719
RedirectUrl	string	否	授權成功後的重新導向位址（OIDC/IDaaS 使用，需要與 OIDC/IDaaS 中設定的重新導向位址保持一致。）	https://test-.com/oauth2/callback
ClientId	string	否	服務註冊的應用程式 ID（OIDC/IDaaS 使用）。	app_mnvxaavggw7hcdcnr6usi6***
ClientSecret	string	否	在 OIDC 認證服務中註冊的應用程式 secret。	CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
CookieDomain	string	否	Cookie 的網域，認證通過後會將 Cookie 傳送到指定的網域，保持登入狀態。例如：設定 `Cookie-domain=a.example.com`，則 Cookie 會傳送到網域 `a.example.com`；設定 `Cookie-domain=.example.com`，則 Cookie 會傳送到 `example.com` 的所有子網域。	test.com
ScopesList	array	否	OIDC 授權範圍（OIDC 使用）。
	string	否	OIDC 授權範圍（OIDC 使用）。	openid
LoginUrl	string	否	IDaaS 執行個體使用者登入頁面位址（IDaaS 使用）。	https://daxxxxcn.aliyunidaas.com/
Sub	string	否	驗證類型為 JWT 時使用；JWT claims 的 sub（subject），即主體，請確保 JWT 的 Payload 中的 sub 欄位的值與此處設定的值一致。如果該參數未設定或者為空，那麼預設與 Issuer 參數設定的值一致。	example-app
ExternalAuthZJSON	object	否	自訂驗證資訊。
ServiceId	integer	否	驗證服務 ID。	37396
PrefixPath	string	否	驗證服務提供的驗證 API 的 Path，API 的 Path 需是前綴匹配。	/auth
TokenKey	string	否	Token 處於請求報文中哪個標頭中，常見的有 Authorization 和 Cookie。	Authorization
AllowRequestHeaders	array	否	允許的請求標頭名稱。
	string	否	允許的請求標頭名稱。	x-req
AllowUpstreamHeaders	array	否	允許的回應標頭名稱。
	string	否	允許的回應標頭名稱。	x-resp
Timeout	integer	否	驗證服務的逾時時間，單位：秒。	10
IsRestrict	boolean	否	自訂驗證模式： true：嚴格模式，當驗證服務不可用時（驗證服務建立連線失敗或者返回 5xx 請求），閘道拒絕用戶端請求。 false：寬鬆模式，當驗證服務不可用時（驗證服務建立連線失敗或者返回 5xx 請求），閘道放過用戶端請求。	true
WithRequestBody	boolean	否	是否允許攜帶 Body。	true
BodyMaxBytes	integer	否	Body 的最大位元組數。	4000000
WithRematchRoute	boolean	否	是否在驗證完成後重新匹配路由。	true
GatewayUniqueId	string	否	閘道唯一識別碼 ID。	gw-9cdcf8e4f58144059e73ff4c5ef9****
IsWhite	boolean	否	授權黑白名單模式： true：白名單模式（名單中的 hosts + paths 不需要校驗即可存取，其餘都需要校驗）。 false：黑名單模式（名單中的 hosts + paths 需要校驗，其餘可直接存取）。	true
AuthResourceMode	integer	否	授權資源模式： 0：簡單模式 1：複雜模式	1
AuthResourceConfig	string	否	複雜模式的 YAML 設定。	''
AuthResourceList	array<object>	否	驗證的授權規則清單，多個規則條件之間是「或」關係，規則條件內的多個匹配項之間是「與」關係。
	array<object>	否	驗證的授權規則清單，多個規則條件之間是「或」關係，規則條件內的多個匹配項之間是「與」關係。
Id	integer	否	資源記錄 ID。	1
DomainId	integer	否	規則內網域的 ID。	1765
Path	string	否	規則的匹配路徑。	/test
MatchType	string	否	請求 Path 的匹配類型： EQUAL：精確匹配 PRE：前綴匹配 ERGULAR：正則匹配	EQUAL
IgnoreCase	boolean	否	路徑是否開啟大小寫敏感（建立自訂驗證時使用，其他驗證類型預設開啟大小寫敏感） true：開啟大小寫敏感 false：關閉大小寫敏感
AuthResourceHeaderList	array<object>	否	規則的請求標頭（目前僅供自訂驗證使用）。
	object	否	規則的請求標頭（目前僅供自訂驗證使用）。
HeaderKey	string	否	請求標頭名稱。	x-req
HeaderMethod	string	否	匹配條件： EQUAL：等於 NOT_EQUAL：不等於 EXIST：存在 NOT_EXIST：不存在 INCLUDE：包含 EXCLUDE：不包含 PREFIX：前綴 SUFFIX：後綴 REGREX：正則	EQUAL
HeaderValue	string	否	請求標頭的值。	123
DeleteResourceIdList	array	否	刪除的資源記錄 ID 清單。
	integer	否	刪除的資源記錄 ID。	2
		否	返回結果顯示的語言。取值：zh（預設值）：中文，en：英文。	zh

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCode	integer	HTTP 狀態碼。	200
Message	string	返回資訊。	OK
Code	integer	code 僅僅用來和 success 同步。	200
Success	boolean	請求結果，取值如下： `true`：請求成功。 `false`：請求失敗。	true
Data	integer	驗證規則 ID。	719

樣本

正常返回樣本

JSON格式

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 719
}

錯誤碼

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

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

變更歷史

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