- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
创建自定义事件通道
功能介绍
创建自定义事件通道。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/channels
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
创建通道时所使用的企业项目id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
通道名称，租户下唯一，由字母，数字，点，下划线和中划线组成，必须字母或数字开头，不能是default 最小长度：1 最大长度：128 |
|
description |
否 |
String |
通道描述 最大长度：255 |
|
eps_id |
否 |
String |
企业项目id |
|
cross_account |
否 |
Boolean |
跨账号 |
|
policy |
否 |
Object |
策略，JSON格式示例 {"Sid":"allow_account_to_put_events","Effect":"Allow","Principal":{"IAM":["domain_id_a", "domain_id_b"]},"Action":"eg:channels:putEvents","Resource":"urn:eg:$region_id:$project_id:channel:$channel_name"} 其中IAM处填写白名单账号的domainId，Resource字段根据实际环境切换变量，其他字段为固定值，请保持一致 |
响应参数
状态码： 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 |
通道名称 |
|
description |
String |
通道描述 |
|
provider_type |
String |
通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道 枚举值：
|
|
created_time |
String |
创建UTC时间 |
|
updated_time |
String |
更新UTC时间 |
|
eps_id |
String |
企业项目id |
状态码： 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 |
请求示例
无
响应示例
状态码： 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 |
Demo Information |
|
400 |
非法请求 |
|
401 |
未授权 |
|
403 |
禁止访问 |
|
404 |
未找到资源 |
|
500 |
内部服务错误 |
错误码
请参见错误码。
