全部产品
Search

搜索本产品

    微服务引擎MSE：GetGatewayAuthConsumerDetail - 获取网关鉴权消费者细节

    文档中心

    微服务引擎MSE：GetGatewayAuthConsumerDetail - 获取网关鉴权消费者细节

    更新时间：Nov 13, 2024

    获取网关鉴权消费者细节。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    mse:GetGatewayAuthConsumerDetailget
    • Gateway
      acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    GatewayUniqueIdstring是

    网关唯一标识 ID。

    		gw-1a4ab101d5924b6f92c5ec98a84*****
    Idlong是

    鉴权消费者 ID。

    		120
    AcceptLanguagestring否

    返回信息的语言类型：

    • zh：中文
    • en：英文
    		zh

    返回参数

    名称类型描述示例值
    object

    RestResult<List>

    RequestIdstring

    请求 ID。

    		316F5F64-F73D-42DC-8632-01E308B6****
    Successboolean

    请求结果，取值如下：

    • true：请求成功。
    • false：请求失败。
    		true
    Codeinteger

    code 仅仅用来和 success 同步。

    		200
    ErrorCodestring

    错误码。

    		mse-100-000
    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    Messagestring

    返回信息。

    		请求处理成功
    DynamicCodestring

    动态错误信息中的占位符。

    		code
    DynamicMessagestring

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

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

    数据结构。

    Idlong

    鉴权消费者 ID。

    		12
    Namestring

    鉴权消费者名称。

    		test
    ConsumerStatusboolean

    鉴权消费者状态：

    • true：启用

    • false：停用

    		true
    PrimaryUserstring

    创建人。

    		123
    GatewayUniqueIdstring

    网关唯一标识 ID。

    		gw-7ea3da97b96543e19f6c597cd4a9****
    Typestring

    鉴权类型：

    • JWT
    		JWT
    GmtCreatestring

    创建时间。

    		2023-02-01 14:17:57
    GmtModifiedstring

    更新时间。

    		2023-03-01 14:17:57
    Descriptionstring

    描述。

    		描述
    EncodeTypestring

    加密类型：

    • RSA

    • OCT

    		RSA
    Jwksstring

    JWT 公钥，支持 JSON 格式。

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

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

    		Authorization
    TokenPassboolean

    是否透传。

    		true
    TokenPositionstring

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

    		HEADER
    TokenPrefixstring

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

    		Bearer
    KeyNamestring

    JWT 内身份标识 KeyName。

    		iss
    KeyValuestring

    JWT 内身份标识 KeyValue。

    		abcd
    ResourceListarray<object>

    资源列表

    resourceobject

    资源列表

    Idlong

    鉴权消费者授权 ID。

    		16
    ConsumerIdlong

    网关鉴权消费者 ID。

    		123
    RouteIdlong

    路由 ID。

    		3458
    RouteNamestring

    路由名称。

    		test
    ResourceStatusboolean

    资源授权状态：

    • true：启用

    • false：停用

    		true
    GatewayUniqueIdstring

    网关唯一标识 ID。

    		gw-4822033a8513496fa10f05c934f*****
    GmtCreatestring

    创建时间。

    		2022-12-06 01:38:03
    GmtModifiedstring

    修改时间。

    		2022-12-06 01:38:03

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "Id": 12,
    "Name": "test",
    "ConsumerStatus": true,
    "PrimaryUser": "123",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Type": "JWT",
    "GmtCreate": "2023-02-01 14:17:57",
    "GmtModified": "2023-03-01 14:17:57",
    "Description": "描述",
    "EncodeType": "RSA",
    "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}",
    "TokenName": "Authorization",
    "TokenPass": true,
    "TokenPosition": "HEADER",
    "TokenPrefix": "Bearer ",
    "KeyName": "iss",
    "KeyValue": "abcd",
    "ResourceList": [
      {
        "Id": 16,
        "ConsumerId": 123,
        "RouteId": 3458,
        "RouteName": "test",
        "ResourceStatus": true,
        "GatewayUniqueId": "gw-4822033a8513496fa10f05c934f*****",
        "GmtCreate": "2022-12-06 01:38:03",
        "GmtModified": "2022-12-06 01:38:03"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400IllegalRequestInvalid request:%s非法请求： %s
    400InvalidParameterParameter error:%s请求参数错误：%s
    403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口：%s
    404NotFoundNot found:%s资源不存在：%s
    500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试：%s

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

    变更历史

    变更时间变更内容概要操作
    2023-08-24API 内部配置变更，不影响调用查看变更详情