ListConsumers - 获取消费者列表_API 网关(API Gateway)-阿里云帮助中心

获取消费者列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apig:ListConsumers	list	全部资源 ``	无	无

请求语法

GET /v1/consumers HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
nameLike	string	否	按接口名称模糊搜索接口。	UI-test
pageNumber	integer	否	分页页码，从 1 开始，不填默认 1。	1
pageSize	integer	否	每页大小，默认 10	10
gatewayType	string	否	网关类型过滤，目前支持 AI、API 两种网关类型。	AI

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	9BDD6A7C-CBA7-504F-B8C5-51B9F16590F7
code	string	响应码。	Ok
message	string	响应消息。	success
data	object	响应数据。
totalSize	integer	总数量。	18
pageNumber	integer	页码。	1
pageSize	integer	分页大小。	10
items	array<object>	消费者信息列表。
item	object	消费者信息。
consumerId	string	消费者 ID。	cs-csheiftlhtgmp0j0hp4g
name	string	消费者名称。	user-service
description	string	描述。	测试消费者
createTimestamp	long	创建时间戳。	1721097861050
updateTimestamp	long	更新时间戳。	1721123855214
deployStatus	string	API 在当前环境的发布状态	{}
enable	boolean	是否启用。	true

示例

正常返回示例

JSON格式

{
  "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": "测试消费者",
        "createTimestamp": 1721097861050,
        "updateTimestamp": 1721123855214,
        "deployStatus": {},
        "enable": true
      }
    ]
  }
}

错误码

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