事件网格 EG-创建事件订阅:请求参数
下载事件网格 EG用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
是 |
String |
订阅名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头 最小长度：1 最大长度：128 |
description |
否 |
String |
订阅描述 最大长度：255 |
channel_id |
是 |
String |
所属事件通道ID |
sources |
是 |
Array of SubscriptionSource objects |
订阅的事件源列表， 当前仅支持订阅一个事件源 数组长度：1 - 1 |
targets |
是 |
Array of SubscriptionTarget objects |
事件目标列表，至少订阅一个事件目标 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
id |
否 |
String |
订阅源ID，需保证全局唯一。指定ID的订阅源存在时则进行更新，否则进行创建；未指定时由系统自动生成。由小写字母、数字、中划线组成，必须字母或数字开头。 最小长度：32 最大长度：64 |
name |
是 |
String |
订阅的事件源名称 最大长度：128 |
provider_type |
是 |
String |
订阅的事件源的提供方类型 枚举值：
|
detail |
否 |
Object |
订阅的事件源参数列表, 该字段序列化后总长度不超过1024字节 |
filter |
是 |
Object |
订阅事件源的匹配过滤规则, 该字段序列化后总长度不超过2048字节 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
id |
否 |
String |
订阅目标ID，需保证全局唯一，由小写字母、数字、中划线组成，必须字母或数字开头。 更新订阅场景时，指定ID的订阅目标存在时则进行更新，否则进行创建； 创建订阅目标场景时，指定ID作为待创建的订阅目标对象ID，未指定时由系统自动生成。 更新订阅目标时，此字段忽略； 最小长度：32 最大长度：64 |
name |
是 |
String |
订阅的事件目标名称 最大长度：128 |
provider_type |
是 |
String |
订阅的事件目标的提供方类型 枚举值：
|
connection_id |
否 |
String |
订阅的事件目标使用的目标链接ID 最大长度：64 |
detail |
否 |
Detail object |
订阅的事件目标参数列表，该字段序列化后总长度不超过1024字节，函数、函数流、webhook订阅目标必填，其中函数、函数流委托名称必填 |
kafka_detail |
否 |
KafkaTargetDetail object |
订阅的事件kafka目标参数列表，该字段序列化后总长度不超过1024字节，kafka订阅目标必填 |
smn_detail |
否 |
SmnTargetDetail object |
订阅的事件smn目标参数列表，该字段序列化后总长度不超过1024字节，smn订阅目标必填 |
transform |
是 |
TransForm object |
订阅的事件目标转换规则 |
dead_letter_queue |
否 |
DeadLetterQueue object |
订阅的死信参数列表 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
url |
否 |
String |
自定义目标url |
agency_name |
否 |
String |
委托名称 |
invocation_http_parameters |
否 |
InvocationHttpParameters object |
|
invoke_type |
否 |
String |
函数调用方式,异步/同步 枚举值：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
header_parameters |
否 |
Array of HeaderParameter objects |
对象列表 数组长度：0 - 5 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
is_value_secret |
否 |
Boolean |
是否加密 |
key |
否 |
String |
header的key值 最小长度：1 最大长度：256 |
value |
否 |
String |
header的value值 最小长度：1 最大长度：1024 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
type |
否 |
String |
键值规则类型 枚举值：
|
value |
否 |
String |
键值规则，键值规则为VARIABLE，CONSTANT时必填 |
template |
否 |
String |
键值规则模板，键值规则为VARIABLE时必填 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
urn |
是 |
String |
主题urn |
agency_name |
是 |
String |
委托名称 |
subject_transform |
否 |
subject_transform object |
标题规则 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
type |
是 |
String |
标题规则类型 枚举值：
|
value |
是 |
String |
标题规则 |
template |
否 |
String |
标题规则模板，键值规则为VARIABLE时必填 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
type |
是 |
String |
转换规则类型 枚举值：
|
value |
否 |
String |
常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 |
template |
否 |
String |
变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 |
