创建自定义事件源
功能介绍
创建用户自定义类型的事件源，只能指定自定义通道，不能指定系统通道。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/sources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
自定义事件源名称，租户下唯一，由小写字母、数字、点、下划线和中划线组成，必须以字母或数字开头，且不能以hc.开头 最小长度：1 最大长度：128 |
|
description |
否 |
String |
事件源描述 最大长度：255 |
|
channel_id |
否 |
String |
指导事件源归属的事件通道ID |
|
type |
否 |
String |
事件源类型 缺省值：APPLICATION 枚举值：
|
|
detail |
否 |
RocketMqDetail object |
json格式封装消息实例链接信息 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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_id |
String |
事件源归属的事件通道ID |
|
channel_name |
String |
事件源归属的事件通道名称 |
|
type |
String |
事件源类型 |
|
detail |
Object |
json格式封装消息实例链接信息：如RabbitMQ实例的instance_id字段、虚拟主机vhost字段、队列queue字段、用户名、密码等 |
|
status |
String |
自定义事件源状态 枚举值：
|
|
error_info |
ErrorInfo object |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_detail |
String |
错误详情 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误信息 最小长度：1 最大长度：128 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误消息 最小长度：1 最大长度：512 |
|
error_details |
String |
具体错误消息 最小长度：1 最大长度：1024 |
|
request_id |
String |
请求处理ID 最小长度：1 最大长度：128 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误消息 最小长度：1 最大长度：512 |
|
error_details |
String |
具体错误消息 最小长度：1 最大长度：1024 |
|
request_id |
String |
请求处理ID 最小长度：1 最大长度：128 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误消息 最小长度：1 最大长度：512 |
|
error_details |
String |
具体错误消息 最小长度：1 最大长度：1024 |
|
request_id |
String |
请求处理ID 最小长度：1 最大长度：128 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误消息 最小长度：1 最大长度：512 |
|
error_details |
String |
具体错误消息 最小长度：1 最大长度：1024 |
|
request_id |
String |
请求处理ID 最小长度：1 最大长度：128 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：1 最大长度：128 |
|
error_msg |
String |
错误消息 最小长度：1 最大长度：512 |
|
error_details |
String |
具体错误消息 最小长度：1 最大长度：1024 |
|
request_id |
String |
请求处理ID 最小长度：1 最大长度：128 |
请求示例
{
"channel_id" : "635d6fc4-8b3e-4c3a-9604-5e4e9c98ea2e",
"description" : null,
"name" : "test",
"type" : "ROCKETMQ",
"detail" : {
"instance_id" : "",
"group" : "group",
"topic" : "topic",
"access_key" : "access_key",
"secret_key" : "secret_key",
"vpc_id" : "2ca947fd-66cd-4c87-8ca4-a47e6bb446a9",
"subnet_id" : "794ff6e0-f9f0-4322-9bce-1ac0178c5498",
"namesrv_address" : "namesrv_address",
"ssl_enable" : false,
"enable_acl" : false
}
}
响应示例
状态码： 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 |
内部服务错误 |
错误码
请参见错误码。
