查询事件通道列表
功能介绍
查询事件通道列表,包括系统通道和自定义通道。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/channels
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户资源空间ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,偏移量不能小于0 |
limit |
否 |
Integer |
每页显示的条目数量,不能小于1或大于1000 |
sort |
否 |
String |
指定查询排序 |
provider_type |
否 |
String |
指定查询提供方的类型 |
name |
否 |
String |
指定查询的事件通道名称,精准匹配 |
fuzzy_name |
否 |
String |
指定查询的事件通道名称,模糊匹配 |
enterprise_project_id |
否 |
String |
指定查询的企业项目id,精确匹配 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数 |
size |
Integer |
本页数量 |
items |
Array of ChannelInfo objects |
对象列表 |
请求示例
查询事件通道列表
GET https://{endpoint}/v1/{project_id}/channels
响应示例
状态码:200
列表
{ "total" : 1, "size" : 1, "items" : [ { } ] }
状态码
状态码 |
描述 |
---|---|
200 |
列表 |
错误码
请参见错误码。