查询消费者列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-beijing |
| GwClusterId |
string |
是 |
网关实例 ID。 |
pg-xxxxxxxxxx |
| ConsumerId |
string |
否 |
用户 ID. |
c-mqveroemc*** |
| ConsumerGroupId |
string |
否 |
用户组 ID。 |
cg-xxxxxxxx |
| ConsumerNameList |
string |
否 |
||
| ConsumerName |
string |
否 |
||
| PageSize |
integer |
否 |
每页记录数，取值范围如下：
|
30 |
| PageNumber |
integer |
否 |
查询页码，默认值为 1。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
24A1990B-4F6E-482B-B8CB-75C612****** |
| TotalRecordCount |
integer |
总记录数。 |
1 |
| PageRecordCount |
integer |
本页记录数。 |
1 |
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
每页记录数，取值范围为 30、50、100，默认值为 30。 |
30 |
| Items |
array<object> |
用户列表 |
|
|
object |
用户对象 |
||
| ConsumerId |
string |
用户 ID. |
c-mqveroemc*** |
| Name |
string |
用户名称 |
test |
| ConsumerGroupId |
string |
用户组 ID。 |
cg-xxxxxx |
| ConsumerGroupName |
string |
用户组名称 |
test |
| NickName |
string |
用户昵称 |
yonghu |
| GmtCreated |
string |
创建时间 |
2026-01-28T09:56:03+08:00 |
| GmtModified |
string |
更新时间 |
2026-01-04T16:09:29+08:00 |
| ApiKey |
string |
完整 APIKey，仅本次返回 |
xxxxxxxx |
| AllowedModels |
string |
支持的模型列表 |
"[]" |
| MtdCostCount |
integer |
当月使用量 |
10 |
| LifetimeCostCount |
integer |
累积使用总量 |
1000 |
| LifetimeTokenCount |
integer |
当月费用总量 |
100 |
| MtdTokenCount |
integer |
累积费用总量 |
10000 |
示例
正常返回示例
JSON格式
{
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"TotalRecordCount": 1,
"PageRecordCount": 1,
"PageNumber": 1,
"PageSize": 30,
"Items": [
{
"ConsumerId": "c-mqveroemc***",
"Name": "test",
"ConsumerGroupId": "cg-xxxxxx",
"ConsumerGroupName": "test",
"NickName": "yonghu",
"GmtCreated": "2026-01-28T09:56:03+08:00",
"GmtModified": "2026-01-04T16:09:29+08:00",
"ApiKey": "xxxxxxxx",
"AllowedModels": "\"[]\"",
"MtdCostCount": 10,
"LifetimeCostCount": 1000,
"LifetimeTokenCount": 100,
"MtdTokenCount": 10000
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。