文档首页/事件网格 EG/API参考/API/事件通道管理/查询事件通道列表 - ListChannels
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询事件通道列表 - ListChannels

功能介绍

查询事件通道列表，包括系统通道和自定义通道。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，偏移量不能小于0

limit

否

Integer

每页显示的条目数量，不能小于1或大于1000

sort

否

String

指定查询排序

provider_type

否

String

指定查询提供方的类型：

  • OFFICIAL：云服务事件通道

  • CUSTOM：自定义事件通道

name

否

String

指定查询的事件通道名称，精准匹配

fuzzy_name

否

String

指定查询的事件通道名称，模糊匹配

enterprise_project_id

否

String

指定查询的企业项目id，精确匹配

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of ChannelInfo objects

对象列表

表5 ChannelInfo

参数

参数类型

描述

id

String

通道ID

name

String

通道名称

description

String

通道描述

provider_type

String

通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

enterprise_project_id

String

企业项目id

请求示例

查询事件通道列表

GET https://{endpoint}/v1/{project_id}/channels

响应示例

状态码：200

列表

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

状态码

状态码

描述

200

列表

错误码

请参见错误码。

父主题：事件通道管理