全部产品
Search

搜索本产品

    微服务引擎MSE：AddGatewayAuthConsumer - 新增网关鉴权消费者

    文档中心

    微服务引擎MSE：AddGatewayAuthConsumer - 新增网关鉴权消费者

    更新时间：Aug 28, 2026

    新增网关鉴权消费者。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    mse:AddGatewayAuthConsumer

    create

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    GatewayUniqueId

    string

    是

    网关唯一标识 ID。

    gw-c70622ff52fe49beb29bea9a6f52****
    Name

    string

    是

    鉴权消费者名称。

    name
    Type

    string

    是

    鉴权类型：

    • JWT

    JWT
    EncodeType

    string

    否

    加密类型：

    • RSA

    • OCT

    RSA
    Jwks

    string

    否

    JWT 公钥，支持 JSON 格式。

    {"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
    TokenName

    string

    否

    要校验的 Token 参数信息的名称，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    Authorization
    TokenPass

    boolean

    否

    是否透传。

    true
    TokenPosition

    string

    否

    要校验的 Token 参数信息的位置，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    HEADER
    TokenPrefix

    string

    否

    要校验的 Token 参数信息的前缀，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    Bearer

    KeyName

    string

    否

    JWT 内身份标识 KeyName。

    iss
    KeyValue

    string

    否

    JWT 内身份标识 KeyValue。

    abcd
    Description

    string

    否

    鉴权消费者描述。

    description
    AcceptLanguage

    string

    否

    返回信息的语言类型：

    • zh：中文

    • en：英文

    zh

    返回参数

    名称

    类型

    描述

    示例值

    object

    RestResult<List>

    RequestId

    string

    请求 ID。

    69AD2AA7-DB47-449B-941B-B14409DF****
    Success

    boolean

    请求结果，取值如下：

    • true：请求成功。

    • false：请求失败。

    True
    Code

    integer

    code 仅仅用来和 success 同步

    200
    ErrorCode

    string

    错误码。

    mse-100-000
    HttpStatusCode

    integer

    HTTP 返回码。

    200
    Message

    string

    返回信息。

    请求处理成功
    DynamicCode

    string

    动态错误信息中的占位符

    code
    DynamicMessage

    string

    动态错误信息，用于替换返回参数 ErrMessage 错误信息中的 %s。

    说明

    如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回DtsJobId，则代表所传入的请求参数DtsJobId不合法。

    The specified parameter is invalid.
    Data

    integer

    鉴权消费者 ID。

    2

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 2
}

    错误码

    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

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

    变更历史

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