DeleteGatewayAuth - 删除网关鉴权 - 微服务引擎MSE

删除网关鉴权

调试

您可以在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****
AcceptLanguage	string	否	返回结果显示的语言。取值：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	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。