DescribeConsumers

Queries the list of consumers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
GwClusterId	string	Yes	The gateway instance ID.	pg-xxxxxxxxxx
ConsumerId	string	No	The user ID.	c-mqveroemc***
ConsumerGroupId	string	No	The user group ID.	cg-xxxxxxxx
PageSize	integer	No	The number of entries to return on each page. Valid values are: 30 50 100. The default is 30.	30
PageNumber	integer	No	The page number. The default value is 1.	1
		No	The number of entries per page. Valid values: 30 50 100 Default value: 30.
		No	The page number. Default value: 1.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	24A1990B-4F6E-482B-B8CB-75C612******
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
Items	array<object>	The list of users.
	object	The user object.
ConsumerId	string	The user ID.	c-mqveroemc***
Name	string	The username.	test
ConsumerGroupId	string	The user group ID.	cg-xxxxxx
ConsumerGroupName	string	The user group name.	test
NickName	string	The nickname.	yonghu
GmtCreated	string	The creation time.	2026-01-28T09:56:03+08:00
GmtModified	string	The update time.	2026-01-04T16:09:29+08:00
ApiKey	string	The full API key, returned only in this response.	xxxxxxxx
AllowedModels	string	The list of supported models.	"[]"
MtdCostCount	integer	The usage for the current month.	10
LifetimeCostCount	integer	The total cumulative usage.	1000
LifetimeTokenCount	integer	The total cost for the current month.	100
MtdTokenCount	integer	The total cumulative cost.	10000

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.