首页 微服务引擎 MSE API参考指南 API目录 云原生网关 安全能力 ListGatewayAuthConsumer - 获取网关鉴权消费者列表

ListGatewayAuthConsumer - 获取网关鉴权消费者列表

获取网关鉴权消费者列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

网关唯一标识ID。

gw-0fe488252dc44d55a9dd57875193****
Namestring

鉴权消费者名称。

test
Typestring

鉴权类型:

  • JWT
JWT
ConsumerStatusboolean

鉴权消费者状态:

  • true:启用

  • false:停用

true
PageNumstring

当前页数值。

1
PageSizestring

当前页的大小。

10
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

RestResult<List>

RequestIdstring

请求ID。

dc63-465d-8ef5-20dc18af****
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

数据结构。

TotalSizelong

查询到的总数。

9
PageNumberinteger

页码。

1
PageSizeinteger

页面大小。

10
Resultarray

返回集合。

object

返回集合。

Idlong

鉴权消费者ID。

1
Namestring

鉴权消费者名称。

test
ConsumerStatusboolean

鉴权消费者状态:

  • true:启用

  • false:停用

true
PrimaryUserstring

创建人。

123
GatewayUniqueIdstring

网关唯一标识ID。

gw-5017305290e14centbrveca****
Typestring

鉴权类型:

  • JWT
JWT
Descriptionstring

鉴权消费者描述。

描述
GmtCreatestring

创建时间。

2021-09-13 19:24:23
GmtModifiedstring

修改时间。

2022-01-07 18:07:57

示例

正常返回示例

JSON格式

{
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "ConsumerStatus": true,
        "PrimaryUser": "123",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "Type": "JWT",
        "Description": "描述",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

错误码

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

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

阿里云首页 微服务引擎 相关技术圈