文档首页/事件网格 EG/API参考/API/事件通道管理/创建自定义事件通道 - CreateChannel
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建自定义事件通道 - CreateChannel

功能介绍

创建自定义事件通道。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

创建通道时所使用的企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

表4 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

通道名称，租户下唯一，由字母，数字，点，下划线和中划线组成，必须字母或数字开头，不能是default

description

否

String

通道描述

enterprise_project_id

否

String

企业项目id

provider_type

否

String

事件通道类型，CUSTOM自定义事件通道，INTERNAL内部事件通道

policy

否

Object

策略

响应参数

状态码：200

表5 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表6 响应Body参数

参数

参数类型

描述

id

String

通道ID

name

String

通道名称

description

String

通道描述

provider_type

String

通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

enterprise_project_id

String

企业项目id

请求示例

创建自定义事件通道

POST https://{endpoint}/v1/{project_id}/channels

{
  "name" : "channel",
  "description" : "first channel",
  "enterprise_project_id" : "string",
  "provider_type" : "CUSTOM",
  "policy" : {
    "additionalProp1" : {
      "Sid" : "allow_account_to_put_events",
      "Effect" : "Allow",
      "Principal" : {
        "additionalProp1" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp2" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp3" : {
          "IAM" : [ "domainID" ]
        }
      },
      "Action" : "eg:channels:putEvents",
      "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
    },
    "additionalProp2" : {
      "Sid" : "allow_account_to_put_events",
      "Effect" : "Allow",
      "Principal" : {
        "additionalProp1" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp2" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp3" : {
          "IAM" : [ "domainID" ]
        }
      },
      "Action" : "eg:channels:putEvents",
      "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
    },
    "additionalProp3" : {
      "Sid" : "allow_account_to_put_events",
      "Effect" : "Allow",
      "Principal" : {
        "additionalProp1" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp2" : {
          "IAM" : [ "domainID" ]
        },
        "additionalProp3" : {
          "IAM" : [ "domainID" ]
        }
      },
      "Action" : "eg:channels:putEvents",
      "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
    }
  }
}

响应示例

状态码：200

Demo Information

{
  "id" : "bd14144e-8f3c-43d6-bdfd-bf09b52c2b96",
  "name" : "channel",
  "description" : "first channel",
  "provider_type" : "CUSTOM",
  "created_time" : "2021-12-09 09:00:00",
  "updated_time" : "2021-12-09 09:00:00",
  "enterprise_project_id" : "string"
}

状态码

状态码

描述

200

Demo Information

错误码

请参见错误码。

父主题：事件通道管理