ListGatewayAuth - 获取网关鉴权列表 - 微服务引擎MSE

获取网关鉴权列表

调试

您可以在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****
AcceptLanguage	string	否	返回结果显示的语言。取值：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	鉴权 id	549
Name	string	鉴权规则名称。	test
GatewayUniqueId	string	网关唯一标识 ID。	gw-e2d226bba4b2445c9e29fa7f8216****
GatewayId	integer	网关 id。	1
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\":[{\"kty\":\"oct\",\"k\":\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\",\"alg\":\"HS256\"}]}
TokenPosition	string	JWT Token 类型： HEADER：通过 Header 传输要校验的 Token 参数信息，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。	HEADER
TokenName	string	JWT Token 保存的位置。要校验的 Token 参数信息，默认是以 Bearer 为前缀放在 Authorization header 中，例如：`Authorization: Bearer token`。	Authorization
TokenNamePrefix	string	JWT Token 的前缀。要校验的 Token 参数信息，默认是以 Bearer 为前缀放在 Authorization header 中，例如：`Authorization: Bearer token`。	Bearer
GmtCreate	string	创建时间。	2021-09-13 19:24:23
GmtModified	string	修改时间。	2021-09-13 19:24:23
TokenPass	boolean	是否透传 Token。	true
IsWhite	boolean	授权黑白名单模式： true：白名单模式（名单中的 hosts + paths 不需要校验即可访问，其余都需要校验） false：黑名单模式（名单中的 hosts + paths 需要校验，其余可直接访问）	true
Status	boolean	启用状态。未启用：false 启用：true	true
RedirectUrl	string	授权成功后的重定向地址（OIDC/IDaaS 使用，需要与 OIDC/IDaaS 中配置的重定向地址保持一致。）	http://test.com/oauth2/callback
ClientId	string	服务注册的应用 ID（OIDC/IDaaS 使用）。	app_mnvxaavggw7hcdcnr6usi6***
ClientSecret	string	服务注册的应用 Secret（OIDC/IDaaS 使用）。	CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
CookieDomain	string	Cookie 的域名，认证通过后会将 Cookie 发送到指定的域名，保持登录状态（OIDC/IDaaS 使用）。	test.com
ScopesList	string	OIDC 授权作用域（OIDC 使用）。	["openid"]
LoginUrl	string	IDaaS 实例用户登录页地址（IDaaS 使用）。	https://daxxxxcn.aliyunidaas.com/
Sub	string	鉴权类型为 JWT 时使用；JWT claims 的 sub(subject)，即主体。	example-app
ExternalAuthZ	object	自定义鉴权信息
ServiceId	integer	鉴权服务 ID。	45186
PrefixPath	string	鉴权服务提供的鉴权 API 的 Path，API 的 Path 需是前缀匹配。	/auth
TokenKey	string	Token 位置，表示 Token 位于请求报文中哪个 Header 中，常见的有 Authorization 和 Cookie	Authorization
AllowRequestHeaders	array	允许的请求头名称。
	string	允许的请求头名称。	x-req
AllowUpstreamHeaders	array	允许的响应头名称。
	string	允许的响应头名称。	x-resp
Timeout	integer	鉴权服务的超时时间，单位：秒	30
WithRequestBody	boolean	是否允许携带 Body。	true
WithRematchRoute	boolean	是否在鉴权完成后重新匹配路由。	true
BodyMaxBytes	integer	Body 的最大字节数。	1024
IsRestrict	boolean	自定义鉴权模式： true：严格模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回 5xx 请求），网关拒绝客户端请求 false：宽松模式，当鉴权服务不可用时（鉴权服务建立连接失败或者返回 5xx 请求），网关放过客户端请求	true
Service	object	鉴权服务信息
Name	string	鉴权服务名称	updatetime
SourceType	string	鉴权服务来源类型	MSE
GroupName	string	服务分组名称。	com.mse.console.test.3YXO
Namespace	string	命名空间	default
AuthResourceMode	integer	授权资源模式： 0：简单模式 1：复杂模式	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	非法请求： %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

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

变更历史

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