文档首页/ 事件网格 EG/ API参考/ API/ 事件源管理/ 查询事件源列表
更新时间：2023-12-12 GMT+08:00
查看PDF
分享

查询事件源列表

功能介绍

支持条件查询，如可以指定事件通道ID来查询某个事件通道下的所有事件源。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/sources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID
表2 Query参数

参数

是否必选

参数类型

描述

channel_id

否

String

指定查询的事件通道ID

offset

否

Integer

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

最小值：0

最大值：100

缺省值：0

limit

否

Integer

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

最小值：1

最大值：1000

缺省值：15

sort

否

String

指定查询排序

缺省值：created_time:DESC

provider_type

否

String

指定查询提供方的类型

枚举值：

  • OFFICIAL

  • CUSTOM

  • PARTNER

name

否

String

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

fuzzy_name

否

String

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

fuzzy_label

否

String

指定查询的事件源标签，模糊匹配

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：16384

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值：0

最大值：100

size

Integer

本页数量

最小值：0

最大值：100

items

Array of CustomizeSourceInfo objects

对象列表

数组长度：0 - 100
表5 CustomizeSourceInfo

参数

参数类型

描述

id

String

事件源ID

name

String

事件源名称

label

String

事件源名称展示

description

String

事件源描述

provider_type

String

事件源提供方类型，OFFICIAL：官方云服务事件源；CUSTOM：用户创建的自定义事件源；PARTNER：伙伴事件源

枚举值：

  • OFFICIAL

  • CUSTOM

  • PARTNER

event_types

Array of event_types objects

事件源提供的事件类型列表，只有官方云服务事件源提供事件类型

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

channel_id

String

事件源归属的事件通道ID

channel_name

String

事件源归属的事件通道名称

type

String

事件源类型

detail

Object

json格式封装消息实例链接信息：如RabbitMQ实例的instance_id字段、虚拟主机vhost字段、队列queue字段、用户名、密码等

status

String

自定义事件源状态

枚举值：

  • CREATE_FAILED

  • RUNNING

  • ERROR

error_info

ErrorInfo object
表6 event_types

参数

参数类型

描述

name

String

事件类型名称

description

String

事件类型描述
表7 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_detail

String

错误详情

最小长度：1

最大长度：128

error_msg

String

错误信息

最小长度：1

最大长度：128

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

请求示例

无

响应示例

状态码： 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码： 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码： 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

查询成功

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码。

父主题： 事件源管理

相关文档