ListConsumers - API Gateway - Alibaba Cloud Documentation Center

Queries a list of consumers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apig:ListConsumers	list	All Resources ``	none	none

Request syntax

GET /v1/consumers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
nameLike	string	No	The name used to perform a fuzzy search for operations.	UI-test
pageNumber	integer	No	The page number to return. Pages start from 1. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
gatewayType	string	No	The instance type. Valid values: AI and API.	AI

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	9BDD6A7C-CBA7-504F-B8C5-51B9F16590F7
code	string	The status code.	Ok
message	string	The status message.	success
data	object	The response payload.
totalSize	integer	The total number of entries returned.	18
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
items	array<object>	The list of consumer information.
item	object	The consumer information.
consumerId	string	The consumer ID.	cs-csheiftlhtgmp0j0hp4g
name	string	The consumer name.	user-service
description	string	The description.	This is the description.
createTimestamp	long	The creation timestamp.	1721097861050
updateTimestamp	long	The last update timestamp.	1721123855214
deployStatus	string	The deployment status of the API in the current environment.	{}
enable	boolean	Indicates if enabled.	true

Examples

Sample success responses

JSONformat

{
  "requestId": "9BDD6A7C-CBA7-504F-B8C5-51B9F16590F7",
  "code": "Ok",
  "message": "success",
  "data": {
    "totalSize": 18,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "consumerId": "cs-csheiftlhtgmp0j0hp4g",
        "name": "user-service",
        "description": "This is the description.",
        "createTimestamp": 1721097861050,
        "updateTimestamp": 1721123855214,
        "deployStatus": {},
        "enable": true
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.