DeleteGatewayAuth - Microservices Engine

刪除閘道驗證。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:DeleteGatewayAuth

delete

*Gateway

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

無

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	否	驗證 ID。	120
GatewayUniqueId	string	否	閘道唯一 ID。	gw-e2d226bba4b2445c9e29fa7f8216****
		否	返回結果顯示的語言。取值：zh（預設值）：中文，en：英文。	zh

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCode	integer	HTTP 狀態碼。	200
Message	string	返回資訊。	OK
Code	integer	用於與 Success 同步，當 Success 為 true 時，Code 為 200。	200
Success	boolean	請求結果，取值如下： `true`：請求成功。 `false`：請求失敗。	true
Data	object	返回資料。
Id	integer	驗證 ID。	120
Name	string	驗證名稱。	test
GatewayUniqueId	string	閘道唯一 ID。	gw-e2d226bba4b2445c9e29fa7f8216****
GatewayId	integer	閘道 ID。	399
Type	string	驗證類型： JWT OIDC IDaaS ExternalAuthZ（自建的驗證服務）	JWT
Issuer	string	驗證類型為 JWT/OIDC 時使用： JWT：表示 JWT claims 的 iss(issuer)，即簽發人。 OIDC：表示 OIDC claims 的 iss(issuer)，即簽發人。	https://example.com/auth
Jwks	string	JWT 公鑰，JSON 格式。	{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] }
IsWhite	boolean	授權黑白名單模式： true：白名單模式（名單中的 hosts + paths 不需要驗證即可存取，其餘都需要驗證）。 false：黑名單模式（名單中的 hosts + paths 需要驗證，其餘可直接存取）。	true
GmtCreate	string	建立時間。	2022-01-07 18:07:57
GmtModified	string	更新時間。	2022-01-07 18:07:57
TokenPosition	string	JWT Token 類型： HEADER：透過 Header 傳輸。要驗證的 Token 參數資訊，預設是以 Bearer 為前綴放在 Authorization header 中，例如：Authorization: Bearer token。	HEADER
TokenName	string	要驗證的 Token 參數資訊的名稱，預設是以 Bearer 為前綴放在 Authorization header 中，例如：`Authorization: Bearer token`。	Authorization
TokenNamePrefix	string	JWT Token 的前綴。	Bearer
TokenPass	boolean	是否透傳 Token。	true
Status	boolean	啟用狀態。未啟用：false。啟用：true。	true
RedirectUrl	string	授權成功後的重新導向位址（OIDC/IDaaS 使用，需要與 OIDC/IDaaS 中設定的重新導向位址保持一致）。	https://yourdomain/path
ClientId	string	服務註冊的應用程式 ID（OIDC/IDaaS 使用）。	example-app
ClientSecret	string	服務註冊的應用程式 Secret（OIDC/IDaaS 使用）。	xxxxx
CookieDomain	string	Cookie 的網域，認證通過後會將 Cookie 傳送到指定的網域，保持登入狀態（OIDC/IDaaS 使用）。	test.com
ScopesList	array	OIDC 作用範圍（OIDC 使用）。
	string	OIDC 作用範圍（OIDC 使用）。	openid
LoginUrl	string	IDaaS 執行個體使用者登入頁面位址（IDaaS 使用）。	https://daxxxxcn.aliyunidaas.com/

樣本

正常返回樣本

JSON格式

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 120,
    "Name": "test",
    "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
    "GatewayId": 399,
    "Type": "JWT",
    "Issuer": "https://example.com/auth",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "IsWhite": true,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07 18:07:57",
    "TokenPosition": "HEADER",
    "TokenName": "Authorization",
    "TokenNamePrefix": "Bearer ",
    "TokenPass": true,
    "Status": true,
    "RedirectUrl": "https://yourdomain/path",
    "ClientId": "example-app",
    "ClientSecret": "xxxxx",
    "CookieDomain": "test.com",
    "ScopesList": [
      "openid"
    ],
    "LoginUrl": "https://daxxxxcn.aliyunidaas.com/"
  }
}

錯誤碼

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

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

變更歷史

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