创建网关鉴权。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mse:AddGatewayAuth | create | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 鉴权名称。 | test |
Type | string | 否 | 鉴权类型:
| JWT |
Issuer | string | 否 | 鉴权类型为 JWT/OIDC 时使用:
| 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"}]} |
TokenPosition | string | 否 | JWT Token 类型:
要校验的 Token 参数信息,默认是以 Bearer 为前缀放在 Authorization header 中,例如:Authorization: Bearer token。 | HEADER |
TokenName | string | 否 | JWT Token 保存的位置。 要校验的 Token 参数信息,默认是以 Bearer 为前缀放在 Authorization header 中,例如: | Authorization |
TokenNamePrefix | string | 否 | JWT Token 的前缀。 要校验的 Token 参数信息,默认是以 Bearer 为前缀放在 Authorization header 中,例如: | Bearer |
TokenPass | boolean | 否 | 是否透传 Token。 | true |
IsWhite | boolean | 否 | 授权黑白名单模式:
| true |
Status | boolean | 否 | 未开放参数,无需传递(鉴权创建后默认为关闭状态)。 | false |
RedirectUrl | string | 否 | 授权成功后的重定向地址(OIDC/IDaaS 使用,需要与 OIDC/IDaaS 中配置的重定向地址保持一致。) | https://test-.com/oauth2/callback |
ClientId | string | 否 | 服务注册的应用 ID(OIDC/IDaaS 使用)。 | 23460e2fdd9bf9ad106**** |
ClientSecret | string | 否 | 服务注册的应用 Secret(OIDC/IDaaS 使用)。 | 123**** |
CookieDomain | string | 否 | Cookie 的域名,认证通过后会将 Cookie 发送到指定的域名,保持登录状态。 例如:设置 | test.com |
ScopesList | array | 否 | OIDC 授权作用域(OIDC 使用)。 | |
string | 否 | OIDC 授权作用域 | openid | |
LoginUrl | string | 否 | IDaaS 实例用户登录页地址(IDaaS 使用)。 | https://daxxxxcn.aliyunidaas.com/ |
Sub | string | 否 | 鉴权类型为 JWT 时使用;JWT claims 的 sub(subject),即主体,请确保 JWT 的 Payload 中的 sub 字段的值与此处配置的值一致。如果该参数未设置或者为空,那么默认与 Issuer 参数设置的值一致 | testing@secure.istio.io |
ExternalAuthZJSON | object | 否 | 自定义鉴权信息。 | |
ServiceId | long | 否 | 鉴权服务 ID。 | 1343 |
PrefixPath | string | 否 | 鉴权服务提供的鉴权 API 的 Path,API 的 Path 需是前缀匹配。 | /auth |
TokenKey | string | 否 | Token 处于请求报文中哪个 Header 中,常见的有 Authorization 和 Cookie。 | Authorization |
AllowRequestHeaders | array | 否 | 鉴权请求中允许携带的头部。 | |
string | 否 | 允许的请求头名称。 | x-req | |
AllowUpstreamHeaders | array | 否 | 鉴权响应中允许保留的头部。 | |
string | 否 | 允许的响应头名称。 | x-resp | |
Timeout | integer | 否 | 鉴权服务的超时时间,单位:秒。 | 10 |
IsRestrict | boolean | 否 | 自定义鉴权模式:
| true |
WithRequestBody | boolean | 否 | 是否允许携带 Body。 | true |
BodyMaxBytes | integer | 否 | Body 的最大字节数。 | 4000000 |
GatewayUniqueId | string | 否 | 网关唯一标识 ID。 | gw-*****9b04bb4474cae9d645be850e3d7 |
AuthResourceMode | integer | 否 | 授权资源模式:
| 1 |
AuthResourceConfig | string | 否 | 复杂模式的 YAML 配置 | |
AuthResourceList | array<object> | 否 | 鉴权的授权规则列表,多个规则条件之间是“或”关系,规则条件内的多个匹配项之间是“与”关系。 | |
object | 否 | 数据结构。 | ||
DomainId | long | 否 | 规则内域名的 ID。 | 1765 |
Path | string | 否 | 规则的匹配路径。 | /test |
MatchType | string | 否 | 请求 Path 的匹配类型:
| EQUAL |
IgnoreCase | boolean | 否 | 路径是否开启大小写敏感(创建自定义鉴权时使用,其他鉴权类型默认开启大小写敏感)
| true |
AuthResourceHeaderList | array<object> | 否 | 规则的请求头(当前仅供自定义鉴权使用) | |
object | 否 | |||
HeaderKey | string | 否 | 请求头名称。 | x-req |
HeaderMethod | string | 否 | 匹配条件:
| EQUAL |
HeaderValue | string | 否 | 请求头的值。 | 123 |
AcceptLanguage | string | 否 | 返回结果显示的语言。取值:zh(默认值):中文,en:英文 | zh |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4279C00F-A5E1-53C6-A43B-751C1C524D0B",
"HttpStatusCode": 200,
"Message": "OK",
"Code": 200,
"Success": true,
"Data": 333
}
错误码
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 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-04-11 | OpenAPI 入参发生变更 | 查看变更详情 |