获取网关鉴权消费者列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mse:ListGatewayAuthConsumer | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GatewayUniqueId | string | 是 | 网关唯一标识 ID。 | gw-0fe488252dc44d55a9dd57875193**** |
| Name | string | 否 | 鉴权消费者名称。 | test |
| Type | string | 否 | 鉴权类型：
| JWT |
| ConsumerStatus | boolean | 否 | 鉴权消费者状态：
| true |
| PageNum | string | 是 | 当前页数值。 | 1 |
| PageSize | string | 是 | 当前页的大小。 | 10 |
| AcceptLanguage | string | 否 | 返回信息的语言类型：
| zh |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-08-24 | API 内部配置变更，不影响调用 | 看变更集 | ||
|