获取网关鉴权详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mse:GetGatewayAuthDetail | get | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Id | long | 否 | 鉴权 ID | 1100 |
| GatewayId | long | 否 | 网关 ID（和网关唯一 ID 二选一） | 2274 |
| GatewayUniqueId | string | 否 | 网关唯一 ID（和网关 ID 二选一，网关唯一 ID 不为空时优先使用网关唯一 ID 查询） | gw-6f0dbd108a0249d2b675b3ef50b***** |
| AcceptLanguage | string | 否 | 返回结果显示的语言。取值：
| zh |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6",
"HttpStatusCode": 200,
"Message": "OK",
"Code": 200,
"Success": true,
"Data": {
"Id": 1100,
"Name": "test",
"GatewayUniqueId": "gw-6f0dbd108a0249d2b675b3ef50b*****",
"GatewayId": 2274,
"Type": "JWT",
"Issuer": "https://example.com/auth",
"Jwks": "{\\n \\\"keys\\\":[\\n {\\n \\\"kty\\\": \\\"RSA\\\",\\n \\\"e\\\": \\\"AQAB\\\",\\n \\\"use\\\": \\\"sig\\\",\\n \\\"kid\\\": \\\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\\",\\n \\\"alg\\\": \\\"RS256\\\",\\n \\\"n\\\": \\\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\\"\\n }\\n ]\\n}\\n",
"IsWhite": true,
"GmtCreate": "2024-02-19T02:41:03.000+0000",
"GmtModified": "2024-02-19T02:41:03.000+0000",
"TokenPosition": "HEADER",
"TokenName": "Authorization",
"TokenNamePrefix": "Bearer ",
"TokenPass": true,
"Status": false,
"RedirectUrl": "https://yourdomain/path",
"ClientId": "example-app",
"ClientSecret": "xxxxx",
"CookieDomain": "hello.com",
"ScopesList": "[\"openid\",\"email\"]",
"LoginUrl": "https://daxxxxcn.aliyunidaas.com/",
"Sub": "https://example.com/auth",
"ExternalAuthZ": {
"ServiceId": 15300,
"PrefixPath": "/auth",
"TokenKey": "Authorization",
"AllowRequestHeaders": [
"x-req"
],
"AllowUpstreamHeaders": [
"x-resp"
],
"Timeout": 10,
"IsRestrict": true,
"Service": {
"Name": " httpbin-auth-service",
"SourceType": "K8s",
"GroupName": "test",
"Namespace": "default"
},
"WithRequestBody": true,
"BodyMaxBytes": 4000000,
"WithRematchRoute": true
},
"ResourceList": [
{
"Id": 1303,
"AuthId": 2274,
"DomainId": 1765,
"DomainName": "example.com",
"Path": "/test",
"IsWhite": true,
"GatewayId": 2274,
"GatewayUniqueId": "gw-6f0dbd108a0249d2b675b3ef50b*****",
"GmtCreate": "2024-02-19T03:32:38.000+0000",
"GmtModified": "2024-02-19T03:32:38.000+0000",
"MatchType": "EQUAL",
"IgnoreCase": true,
"AuthResourceHeaderList": [
{
"HeaderKey": "x-req",
"HeaderMethod": "EQUAL",
"HeaderValue": "123"
}
]
}
],
"AuthResourceMode": 0,
"AuthResourceConfig": "permissions:\n - not_rule:\n or_rules:\n rules:\n - and_rules:\n rules:\n - url_path:\n path:\n ignore_case: false\n prefix: /version\n - and_rules:\n rules:\n - url_path:\n path:\n ignore_case: false\n prefix: /header"
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | 非法请求： %s |
| 400 | InvalidParameter | Parameter error:%s | 请求参数错误：%s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口：%s |
| 404 | NotFound | Not found:%s | 资源不存在：%s |
| 500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试：%s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |