查询事件源列表 - ListEventSources
功能介绍
支持条件查询,如可以指定事件通道ID来查询某个事件通道下的所有事件源。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sources
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户资源空间ID |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
channel_id | 否 | String | 指定查询的事件通道ID |
offset | 否 | Integer | 偏移量,表示从此偏移量开始查询,偏移量不能小于0 |
limit | 否 | Integer | 每页显示的条目数量,不能小于1或大于1000 |
sort | 否 | String | 指定查询排序 |
provider_type | 否 | String | 指定查询提供方的类型:
|
name | 否 | String | 指定查询的事件源名称,精准匹配 |
fuzzy_name | 否 | String | 指定查询的事件源名称,模糊匹配 |
fuzzy_label | 否 | String | 指定查询的事件源标签,模糊匹配 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
total | Integer | 总数 |
size | Integer | 本页数量 |
items | Array of CustomizeSourceInfo objects | 对象列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 事件源ID |
name | String | 事件源名称 |
label | String | 事件源名称展示 |
description | String | 事件源描述 |
provider_type | String | 事件源提供方类型,OFFICIAL:官方云服务事件源;CUSTOM:用户创建的自定义事件源;PARTNER:伙伴事件源 |
event_types | Array of event_types objects | 事件源提供的事件类型列表,只有官方云服务事件源提供事件类型 |
created_time | String | 创建UTC时间 |
updated_time | String | 更新UTC时间 |
channel_name | String | 事件源归属的事件通道名称 |
type | String | 事件源类型:
|
detail | Object | json格式封装消息实例链接信息:如RabbitMQ实例的instance_id字段、虚拟主机vhost字段、队列queue字段、用户名、密码等 |
status | String | 自定义事件源状态:
|
error_info | ErrorInfo object | 错误信息 |
请求示例
查询事件源列表
GET https://{endpoint}/v1/{project_id}/sources 响应示例
状态码:200
查询成功
{
"total" : 1,
"size" : 1,
"items" : [ { } ]
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询成功 |
错误码
请参见错误码。

