本文介绍事件目标中的元数据参数。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
EventBusName | String | 是 | default | 事件总线的名称。更多信息,请参见使用限制。 |
RuleName | String | 是 | MNSRule | 事件规则的名称。更多信息,请参见使用限制。 |
Description | String | 否 | MNS的过滤规则。 | 规则说明。 |
Status | String | 否 | ENABLE | 规则的状态。取值说明如下:
默认值:ENABLE。 |
FilterPattern | String | 否 | {\"source\": [{\"prefix\": \"acs.\"}],\"type\": [{\"prefix\":\"oss:ObjectReplication\"}],\"subject\":[{\"prefix\":\"acs:oss:cn-hangzhou:123456789098****:my-movie-bucket/\", \"suffix\":\".txt\"}]} | 事件模式。格式为JSON。取值说明,请参见事件模式。 |
Targets | List<Target> | 是 | 事件的投递目标。 | |
Id | String | 是 | 1 | 自定义的事件目标ID,在当前规则下不可重名。 |
Type | String | 是 |
| 事件目标类型。更多信息,请参考下文关于各事件目标的详细介绍。 |
Endpoint | String | 否 |
| 投递端点链接。更多信息,请参考下文关于各事件目标的Endpoint格式。 |
PushRetryStrategy | String | 是 | BACKOFF_RETRY | 推送重试策略。取值说明如下:
|
DeadLetterQueue | String | 否 | 死信队列。未处理或者超过重试次数的事件会被写入死信。支持的队列类型有轻量消息队列(原 MNS)和云消息队列 RocketMQ 版。 | |
Arn | String | 否 |
| 死信队列的Arn,未处理或超过重试次数的事件会被写入死信。支持的队列类型有轻量消息队列(原 MNS)和云消息队列 RocketMQ 版。 |
ParamList | List<Param> | 是 | 事件传递的参数。 | |
resourceKey | String | 是 | body | 目标服务的参数。 |
form | String | 是 | TEMPLATE | 事件转换的格式。有四种类型:
|
value | String | 是 |
| 事件转换的值。 |
template | String | 否 |
| 事件转换模板样式。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
RuleARN | String |
| 事件规则的ARN,用于授权。 |
钉钉
当事件目标选择钉钉时,元数据参数中的Type值为acs.dingtalk
,Endpoint表示配置的钉钉URL地址,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
URL | 是 | CONSTANT | URL地址。 | 无 |
SecretKey | 是 | CONSTANT | 密钥。 | 无 |
Body | 是 | TEMPLATE | 定义TEMPLATE的Key和Value。 | 定义消息体的模板。 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.dingtalk",
"Endpoint":"https://oapi.dingtalk.com/robot/send?access_token=1560abe367f48877c69bb6a9916244979927abbbbf82f4fe8801692cd6ea****",
"ParamList":[
{
"Value":"https://oapi.dingtalk.com/robot/send?access_token=1560abe367f48877c69bb6a9916244979927abbbbf82f4fe8801692cd6ea****",
"ResourceKey":"URL",
"Form":"CONSTANT"
},
{
"Value":"SEC1eca5209e0c6c23165b9504967522d47b0d0004e1caf3a75f6ddfda7359d****",
"ResourceKey":"SecretKey",
"Form":"CONSTANT"
},
{
"Value":{
"content":"$.data.content"
},
"ResourceKey":"Body",
"Form":"TEMPLATE",
"Template":{
"Msgtype":"text",
"Text":{
"content":"@1851111***** ${content}"
},
"At":{
}
}
}
]
}
邮箱
当事件目标选择邮箱时,元数据参数中的Type值为acs.mail
,Endpoint表示配置的邮箱的URL地址,格式为acs:mail:${region}:${uid}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
Subject | 是 | CONSTANT | 主题。 | 无 |
AccountName | 是 | CONSTANT | 发信地址。 | 无 |
AddressType | 是 | CONSTANT | 地址类型。 | 无 |
ReplyToAddress | 是 | CONSTANT | 回信地址。 | 无 |
ToAddress | 是 |
| 收件人地址。 | 无 |
IsHtmlBody | 是 | CONSTANT | 是否为HTML正文。取值如下:
| 无 |
Body | 是 | TEMPLATE | 定义TEMPLATE的Key和Value。 | 定义消息体的模板。 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.mail",
"Endpoint":"acs:mail:cn-hangzhou:164901546557****",
"ParamList":[
{
"Value":"test",
"ResourceKey":"Subject",
"Form":"CONSTANT"
},
{
"Value":"example.com",
"ResourceKey":"AccountName",
"Form":"CONSTANT"
},
{
"Value":"1",
"ResourceKey":"AddressType",
"Form":"CONSTANT"
},
{
"Value":"true",
"ResourceKey":"ReplyToAddress",
"Form":"CONSTANT"
},
{
"Value":"$.data.name",
"EsourceKey":"ToAddress",
"Form":"JSONPATH"
},
{
"Value":"true",
"ResourceKey":"IsHtmlBody",
"Form":"CONSTANT"
},
{
"Value":{
"Mobile":"$.data.mobile",
"Subject":"$.subject"
},
"ResourceKey":"Body",
"Form":"TEMPLATE",
"Template":{
"Code":"${subject}"
}
}
]
}
短信
当事件目标选择短信时,元数据参数中的Type值为acs.sms
,Endpoint表示配置短信的URL地址,格式为acs:sms:${region}:${uid}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
PhoneNumbers | 是 |
| 手机号码。 | 无 |
SignName | 是 | CONSTANT | 签名名称。 | 无 |
TemplateCode | 是 | CONSTANT | 短信服务的模板Code。 | 无 |
TemplateParam | 是 | TEMPLATE | 定义TEMPLATE的Key和Value。 | 定义消息体的模板。 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.sms",
"Endpoint":"acs:sms:cn-hangzhou:164901546557****",
"ParamList":[
{
"Value":"$.data",
"ResourceKey":"PhoneNumbers",
"Form":"JSONPATH"
},
{
"Value":"[测试专用]阿里云通信",
"ResourceKey":"SignName",
"Form":"CONSTANT"
},
{
"Value":" [测试专用]阿里云通信测试模版",
"ResourceKey":"TemplateCode",
"Form":"CONSTANT"
},
{
"Value":{
"Mobile":"$.data.mobile",
"Subject":"$.subject"
},
"ResourceKey":"TemplateParam",
"Form":"TEMPLATE",
"Template":{
"Code":"${subject}"
}
}
]
}
函数计算
当事件目标选择函数计算时,元数据参数中的Type值为acs.fc.function
,Endpoint表示配置的URL地址,格式为acs:fc:${region}:${uid}:services/${serviceName}.${Qualifier}/functions/${functionName}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
serviceName | 是 | CONSTANT | 服务。 | 无 |
functionName | 是 | CONSTANT | 函数。 | 无 |
Body | 是 |
| 函数的消息体内容,定义TEMPLATE的Key和Value。 | 定义消息体的模板。 |
InvocationType | 是 | CONSTANT | 调用类型。取值如下:
| 无 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.fc.function",
"Endpoint":"acs:fc:cn-hangzhou:164901546557****:services/guide-hello_world.LATEST/functions/hello_world",
"ParamList":[
{
"Value":"guide-hello_world",
"ResourceKey":"serviceName",
"Form":"CONSTANT"
},
{
"Value":"hello_world",
"ResourceKey":"functionName",
"Form":"CONSTANT"
},
{
"Value":"$.data.name",
"ResourceKey":"Body",
"Form":"JSONPATH"
},
{
"Value":"LATEST",
"ResourceKey":"Qualifier",
"Form":"CONSTANT"
}
]
}
轻量消息队列
当事件目标选择轻量消息队列(原 MNS)时,元数据参数中的Type值为acs.mns.queue
,Endpoint表示配置的URL地址,格式为acs:mns:${region}:${uid}:queues/${queue}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
queue | 是 | CONSTANT | 队列。 | 无 |
Body | 是 |
| 根据form配置消息内容。 | 如果form选择TEMPLATE,则在此处配置模板。 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.mns.queue",
"Endpoint":"acs:mns:cn-hangzhou:164901546557****:queues/MyQueue",
"ParamList":[
{
"Value":"MyQueue",
"ResourceKey":"queue",
"Form":"CONSTANT"
},
{
"Value":{
"Source":"$.source"
},
"ResourceKey":"Body",
"Form":"TEMPLATE",
"Template":"The event comes from ${source} is abnormal."
}
]
}
云消息队列 RocketMQ 版
当事件目标选择云消息队列 RocketMQ 版时,元数据参数中的Type值为acs.rocketmq
,Endpoint表示配置的URL地址,格式为acs:mq:${region}:${uid}:/instances/${instanceId}/topic/${topic}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
InstanceId | 是 | CONSTANT | 实例ID。 | 无 |
Topic | 是 | CONSTANT | 主题。 | 无 |
Body | 是 |
| 消息体。 | 如果form选择TEMPLATE,则在此处配置模板。 |
Properties | 否 |
| 属性。 | 无 |
Keys | 否 |
| 关键标识。 | 如果form选择TEMPLATE,则在此处配置模板。 |
Tags | 否 |
| 标签。 | 如果form选择TEMPLATE,则在此处配置模板。 |
JSONPath示例如下:
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.rocketmq",
"Endpoint":"acs:mq:cn-hangzhou:164901546557****:/instances/${instanceId}/topic/${topic}",
"ParamList":[
{
"Value":"MQ_INST_164901546557****_BAAQ4gWo",
"ResourceKey":"InstanceId",
"Form":"CONSTANT"
},
{
"Value":"test-topic1",
"ResourceKey":"Topic",
"Form":"CONSTANT"
},
{
"Value":"$.data.name",
"ResourceKey":"Body",
"Form":"JSONPATH"
},
{
"Value":"$.data.userProperties",
"ResourceKey":"Properties",
"Form":"JSONPATH"
},
{
"Value":"$.data.systemProperties.KEYS",
"ResourceKey":"Keys",
"Form":"JSONPATH"
},
{
"Value":"$.data.systemProperties.TAGS",
"ResourceKey":"Tags",
"Form":"JSONPATH"
}
]
}
云消息队列 RabbitMQ 版
当事件目标选择云消息队列 RabbitMQ 版时,元数据参数中的Type值为acs.rabbitmq
,Endpoint表示配置的URL地址,格式为acs:amqp:${region}:${uid}:/instances/${instanceId}/vhosts/${vhostName}/exchanges/${exchangeName}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
InstanceId | 是 | CONSTANT | 实例ID。 | 无 |
Vhost | 是 | CONSTANT | 虚拟机。 | 无 |
TargetType | 是 | CONSTANT | 目标类型。 说明 参数Exchange和Queue同时只能选择其中一个。 | 无 |
Exchange | 否,仅当TargetType取值为Exchange时必传。 | CONSTANT | Exchange模式。 | 无 |
Queue | 否,仅当TargetType取值为Queue时必传。 | CONSTANT 说明 参数Exchange和Queue同时只能选择其中一个。 | Queue模式。 | 无 |
Body | 是 |
| 消息体。 | 如果form选择TEMPLATE,则在此处配置模板。 |
MessageId | 否,默认自动生成。 |
| 消息ID。 | 如果form选择TEMPLATE,则在此处配置模板。 |
Properties | 否 |
| 属性。 | 如果form选择TEMPLATE,则在此处配置模板。 |
JSONPath示例如下:
示例一:目标类型为Exchange
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.rabbitmq",
"Endpoint":"acs:amqp:cn-hangzhou:164901546557****:/instances/${instanceId}/vhosts/${vhostName}/exchanges/${exchangeName}",
"ParamList":[
{
"Value":"amqp-cn-i7m29o3s****",
"ResourceKey":"InstanceId",
"Form":"CONSTANT"
},
{
"Value":"test.host",
"ResourceKey":"Vhost",
"Form":"CONSTANT"
},
{
"Value":"Exchange",
"ResourceKey":"TargetType",
"Form":"CONSTANT"
},
{
"Value":"amq.direct",
"ResourceKey":"Exchange",
"Form":"CONSTANT"
},
{
"Value":"$.data.name",
"ResourceKey":"RoutingKey",
"Form":"JSONPATH"
},
{
"Value":"$.data.name",
"ResourceKey":"Body",
"Form":"JSONPATH"
},
{
"Value":"$.data.message",
"ResourceKey":"MessageId",
"Form":"JSONPATH"
},
{
"Value":"$.data.userProperties",
"ResourceKey":"Properties",
"Form":"JSONPATH"
}
]
}
示例二:目标类型为Queue
{
"Id":"EldwXoVAws5Ix8VpVmrDmr****",
"Type":"acs.rabbitmq",
"Endpoint":"acs:amqp:cn-hangzhou:164901546557****:/instances/${instanceId}/vhosts/${vhostName}/exchanges/${exchangeName}",
"ParamList":[
{
"Value":"amqp-cn-i7m29o3s****",
"ResourceKey":"InstanceId",
"Form":"CONSTANT"
},
{
"Value":"test.host",
"ResourceKey":"Vhost",
"Form":"CONSTANT"
},
{
"Value":"Queue",
"ResourceKey":"TargetType",
"Form":"CONSTANT"
},
{
"Value":"test.event",
"ResourceKey":"Queue",
"Form":"CONSTANT"
},
{
"Value":"$.data.body",
"ResourceKey":"Body",
"Form":"JSONPATH"
},
{
"Value":"$.data.message",
"ResourceKey":"MessageId",
"Form":"JSONPATH"
},
{
"Value":"$.data.userproperties",
"ResourceKey":"Properties",
"Form":"JSONPATH"
}
]
}
云消息队列 Kafka 版
当事件目标选择云消息队列 Kafka 版时,元数据参数中的Type值为acs.alikafka
,Endpoint表示配置的URL地址,格式为acs:alikafka:${regionId}:${accountId}:topics/${topic}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
InstanceId | 是 | CONSTANT | Kafka实例ID。 | 无 |
Topic | 是 | CONSTANT | 主题名称。 | 无 |
Value | 是 |
| 消息体。 | 事件转换的格式。有四种类型:
|
Key | 是 | JSONPATH | 消息键值。 | 请参见Value的template。 |
Acks | 是 | CONSTANT | 确认模式。 | 无 |
JSONPath示例如下:
{
"id":"1rypRt1I9ET6Aks9Y6NNg6U****",
"type":"acs.alikafka",
"endpoint":"acs:alikafka:cn-huhehaote:118609547428****:topics/test-topic",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"value":"alikafka_pre-cn-zpr3fwhe****",
"resourceKey":"InstanceId",
"form":"CONSTANT"
},
{
"value":"test-topic",
"resourceKey":"Topic",
"form":"CONSTANT"
},
{
"value":"$.data",
"resourceKey":"Value",
"form":"JSONPATH"
},
{
"value":"$.data.key",
"resourceKey":"Key",
"form":"JSONPATH"
},
{
"value":"0",
"resourceKey":"Acks",
"form":"CONSTANT"
}
]
}
日志服务SLS
当事件目标选择日志服务SLS时,元数据参数中的Type值为acs.sls
Endpoint表示配置的URL地址,格式为acs:sls:${regionId}:${accountId}:project/${project}/logstore/${logstore}
;ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
Project | 是 | CONSTANT | 日志项目名称。 | 无 |
LogStore | 是 | CONSTANT | 日志库名称。 | 无 |
Topic | 否 |
| 日志主题。 | 事件转换的格式。共有以下四种类型:
|
Body | 否 |
| 日志内容。 | 请参见Topic的template。 |
ContentType | 是 | CONSTANT | 内容类型。 | 可选值为JSON、KeyValue,默认为JSON。
|
RoleName | 是 | CONSTANT | 角色配置。 | 无 |
ContentSchema | 否 | CONSTANT | 自定义写入SLS日志的索引和值的内容模板。 |
其中字段名“Key_1”、“Value_1”表示一对索引与值。 |
JSONPath示例如下:
{
"id":"MwOpn5yyemTlQjE5JwYjme****",
"type":"acs.sls",
"endpoint":"acs:sls:cn-hangzhou:182572506381****:project/${project}/logstore/${logstore}",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"value":"testproject37****",
"resourceKey":"Project",
"form":"CONSTANT"
},
{
"value":"testlogstore37****",
"resourceKey":"LogStore",
"form":"CONSTANT"
},
{
"value":"$.data.topic",
"resourceKey":"Topic",
"form":"JSONPATH"
},
{
"value":"KeyValue",
"resourceKey":"ContentType",
"form":"CONSTANT"
},
{
"value":"AliyunEventBridgeSLS-248QJd****",
"resourceKey":"RoleName",
"form":"CONSTANT"
},
{
"value":"{\"Key_1\":{\"form\":\"CONSTANT\",\"value\":\"name\"},\"Value_1\":{\"form\":\"CONSTANT\",\"value\":\"age\"}}",
"resourceKey":"ContentSchema",
"form":"CONSTANT"
}
]
}
HTTP/HTTPS
当事件目标选择HTTP/HTTPS时,元数据参数中的Type值为http
或者https
,Endpoint表示配置的URL地址,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
url | 是 | CONSTANT | URL地址。 | 无 |
Body | 是 |
| 目前仅支持HTTP Body,如果需要使用Header、Query,请参考管理API端点。 | 若form为TEMPALTE,则此处配置对应模板,模板中的变量来自于value。 |
Network | 是 | CONSTANT | 网络类型。取值说明如下:
| 无 |
VPCNameAndId | 否,当Network取值为PrivateNetwork时必传。 | CONSTANT | 目标端所在的VPC信息,格式: | 无 |
VSwitchesNameAndId | 否,当Network取值为PrivateNetwork时必传。 | CONSTANT | 目标端所在VPC的vSwitch信息,支持多个vSwitch。格式为JsonString。例如: | 无 |
SecurityGroupNameAndId | 否,当Network取值为PrivateNetwork时必传。 | CONSTANT | 目标端所在VPC的安全组信息,格式: | 无 |
Token | 否,默认为空。 | CONSTANT | 用于签名校验,Header Key固定为: | 无 |
JSONPath示例如下:
示例一:网络类型为公网
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"https",
"Endpoint":"http(s)://www.****.com/product/aliware/eventbridge",
"ParamList":[
{
"Value":"http(s)://www.****.com/product/aliware/eventbridge",
"ResourceKey":"url",
"Form":"CONSTANT"
},
{
"Value":"",
"ResourceKey":"Body",
"Form":"ORIGINAL"
},
{
"Value":"PublicNetwork",
"ResourceKey":"Network",
"Form":"CONSTANT"
}
]
}
示例二:网络类型为专有网络
{
"Id":"ZOiNcqqzTGSrDJanZQ72vj****",
"Type":"http",
"Endpoint":"http(s)://192.168.XX.XX:8080",
"ParamList":[
{
"Value":"http(s)://192.168.XX.XX:8080",
"ResourceKey":"url",
"Form":"CONSTANT"
},
{
"Value":"",
"ResourceKey":"Body",
"Form":"ORIGINAL"
},
{
"Value":"PrivateNetwork",
"ResourceKey":"Network",
"Form":"CONSTANT"
},
{
"Value":"catalog-system/vpc-bp1ohdo84u2lt9wzq****",
"ResourceKey":"VPCNameAndId",
"Form":"CONSTANT"
},
{
"Value":"[\"eb/vsw-bp10rbrt6rb6vrd89****\"]",
"ResourceKey":"VSwitchesNameAndId",
"Form":"CONSTANT"
},
{
"Value":"sg-catalog-eventlistener/sg-bp14zrnfyik5av27****",
"ResourceKey":"SecurityGroupNameAndId",
"Form":"CONSTANT"
},
{
"Value":"",
"ResourceKey":"Token",
"Form":"CONSTANT"
}
]
}
数据库
当事件目标选择RDS For MySQL数据库时,元数据参数中的Type值为
acs.rds.mysql
,Endpoint表示配置的URL地址,格式为acs:rds:${region}:${uid}:dbinstance/${dbinstanceid}
,ParamList中的resourceKey字段含义如下表所示。resourceKey
是否必传
form
value
template
InstanceId
是
CONSTANT
实例ID。
无
DBName
是
CONSTANT
数据库名称。
无
AccountName
是
CONSTANT
数据库账号。
无
AccountPassword
是
CONSTANT
数据库密码。
无
ExecuteSQL
是
ORIGINAL
CONSTANT
JSONPATH
TEMPLATE
自定义SQL。
如果form选择TEMPLATE,则在此处配置模板。
VpcId
是
CONSTANT
VPC ID。
无
VSwitchIds
是
CONSTANT
虚拟交换机ID。
无
SecurityGroupId
是
CONSTANT
安全组ID。
无
JSONPath示例如下:
{ "Id":"BRTt1sNe3IvdvejN07k5Sb****", "Type":"acs.rds.mysql", "Endpoint":"acs:rds:cn-zhangjiakou:164901546557****:dbinstance/${dbinstanceid}", "ConcurrentConfig":{ "Concurrency":10 }, "ParamList":[ { "Value":"rm-8vban2a66q93o****", "ResourceKey":"InstanceId", "Form":"CONSTANT" }, { "Value":"db-test", "ResourceKey":"DBName", "Form":"CONSTANT" }, { "Value":"db_name", "ResourceKey":"AccountName", "Form":"CONSTANT" }, { "Value":"Aliyun****", "ResourceKey":"AccountPassword", "Form":"CONSTANT" }, { "Value":"{\n \"tableName\": \"customer\",\n \"column1\": \"$.data.tableName\",\n \"column1_value\": \"$.data.id\"\n}", "Template":"INSERT INTO ${tableName} \n (${column1}) VALUES('${column1_value}')", "ResourceKey":"ExecuteSQL", "Form":"TEMPLATE" }, { "Value":"vpc-8vbeokru8z8erie8e****", "ResourceKey":"VpcId", "Form":"CONSTANT" }, { "Value":"vsw-8vb9alm00nf29ijxt****", "ResourceKey":"VSwitchIds", "Form":"CONSTANT" } { "Value":"sg-8vbb59f5vq1ydiwr****", "ResourceKey":"SecurityGroupId", "Form":"CONSTANT" } ] }
当事件目标选择自建MySql数据库时,元数据参数中的Type值为
mysql
,Endpoint配置格式为数据库地址${ConnectionStringAndPort}
,ParamList中的resourceKey字段含义如下表所示。resourceKey
是否必传
form
value
template
ConnectionStringAndPort
是
CONSTANT
数据库地址。
无
DBName
是
CONSTANT
数据库名称。
无
AccountName
是
CONSTANT
数据库账号。
无
AccountPassword
是
CONSTANT
数据库密码。
无
ExecuteSQL
是
ORIGINAL
CONSTANT
JSONPATH
TEMPLATE
自定义SQL。
无
Network
是
CONSTANT
网络类型。取值如下:
PublicNetwork:公网。
PrivateNetwork:VPC网络,如果选择此项,需要配置VPC、vSwitch和SecurityGroup信息。
无
VpcId
否,当Network取值为PrivateNetwork时必传。
CONSTANT
VPC ID。
无
VSwitchIds
否,当Network取值为PrivateNetwork时必传。
CONSTANT
虚拟交换机ID。
无
SecurityGroupId
否,当Network取值为PrivateNetwork时必传。
CONSTANT
安全组ID。
无
示例一:网络配置为公网
{ "Id":"HmfVOvdG4k1NK9qJiqrxtv****", "Type":"mysql", "Endpoint":"192.168.XX.XX:3306", "ConcurrentConfig":{ "Concurrency":10 }, "ParamList":[ { "Value":"192.168.XX.XX:3306", "ResourceKey":"ConnectionStringAndPort", "Form":"CONSTANT" }, { "Value":"db-test", "ResourceKey":"DBName", "Form":"CONSTANT" }, { "Value":"dbTest", "ResourceKey":"AccountName", "Form":"CONSTANT" }, { "Value":"Mydb****", "ResourceKey":"AccountPassword", "Form":"CONSTANT" }, { "Value":"{\n \"tableName\": \"user\",\n \"column1\": \"$.data.tableName\",\n \"column1_value\": \"$.data.id\"\n}", "Template":"INSERT INTO ${tableName} \n (${column1}) VALUES('${column1_value}')", "ResourceKey":"ExecuteSQL", "Form":"TEMPLATE" }, ] }
示例二:网络配置为专有网络VPC
{ "Id":"HmfVOvdG4k1NK9qJiqrxtv****", "Type":"mysql", "Endpoint":"192.168.XX.XX:3306", "ConcurrentConfig":{ "Concurrency":10 }, "ParamList":[ { "Value":"vpc-8vbeokru8z8erie8e****", "ResourceKey":"VpcId", "Form":"CONSTANT" }, { "Value":"vsw-8vbo9jk84z0obm24f****", "ResourceKey":"VSwitchIds", "Form":"CONSTANT" }, { "Value":"192.168.XX.XX:3306", "ResourceKey":"ConnectionStringAndPorte", "Form":"CONSTANT" }, { "Value":"my-db", "ResourceKey":"DBName", "Form":"CONSTANT" }, { "Value":"dmsTest", "ResourceKey":"AccountName", "Form":"TEMPLATE" }, { "Value":"Mydb****", "ResourceKey":"AccountPassword", "Form":"CONSTANT" }, { "Value":"{\n \"tableName\": \"user\",\n \"column1\": \"$.data.tableName\",\n \"column1_value\": \"$.data.id\"\n}", "Template": "INSERT INTO ${tableName} \n (${column1}) VALUES('${column1_value}')", "ResourceKey":"ExecuteSQL", "Form":"TEMPLATE" } ] }
事件总线EventBridge
当事件目标选择为事件总线EventBridge时,元数据参数中的Type为acs.eventbridge
,Endpoint格式为acs:eventbridge:${region}:${AccountId}:eventbus/${EventBusName}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
RegionId | 是 | CONSTANT | 投递的目标地域ID。 | 无 |
AccountType | 是 | CONSTANT | 账号类型,取值如下:
| 无 |
AccountId | 否,默认为当前账号。 | CONSTANT | 写入目标账号ID;如果AccountType为SameAccount,可不填写此参数。 | 无 |
EventBusName | 是 | CONSTANT | 写入目标总线的名称。 | 无 |
RAMRoleName | 否,跨账号投递时必传。 | CONSTANT | 授予的角色名称。详细信息,请参见路由到事件总线EventBridge。如果AccountType为SameAccount,可不填写此参数。 | 无 |
Body | 是 | ORIGINAL,表示投递完整事件。 | 无。 | 无 |
JSONPath示例如下:
示例一:写入当前账号的事件总线
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.eventbridge",
"Endpoint":"acs:eventbridge:cn-hangzhou:xxxxx:eventbus/xxxxx",
"ParamList":[
{
"Value":"cn-hangzhou",
"ResourceKey":"RegionId",
"Form":"CONSTANT"
},
{
"Value":"SameAccount",
"ResourceKey":"AccountType",
"Form":"CONSTANT"
},
{
"Value":"xxxxx",
"ResourceKey":"EventBusName",
"Form":"CONSTANT"
},
{
"ResourceKey":"Body",
"Form":"ORIGINAL"
}
]
}
示例二:写入其他账号的事件总线
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.eventbridge",
"Endpoint":"acs:eventbridge:cn-hangzhou:xxxxx:eventbus/xxxxx",
"ParamList":[
{
"Value":"cn-hangzhou",
"ResourceKey":"RegionId",
"Form":"CONSTANT"
},
{
"Value":"AnotherAccount",
"ResourceKey":"AccountType",
"Form":"CONSTANT"
},
{
"Value":"xxxxx",
"ResourceKey":"AccountId",
"Form":"CONSTANT"
},
{
"Value":"xxxxx",
"ResourceKey":"EventBusName",
"Form":"CONSTANT"
},
{
"Value":"xxxxx",
"ResourceKey":"RAMRoleName",
"Form":"CONSTANT"
},
{
"ResourceKey":"Body",
"Form":"ORIGINAL"
}
]
}
API触发
当事件目标选择为API端点时,元数据参数中的Type为acs.api.destination
,Endpoint格式为acs:api-destination:${region}:${AccountId}:eventbus/${APIName}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
Name | 是 | CONSTANT | API端点名称 | 无 |
HeaderParameters | 否 | TEMPLATE | 请求头参数 | 在此处配置模板。 |
BodyParameters | 否 | TEMPLATE | 请求体参数 | 在此处配置模板。 |
QueryStringParameters | 否 | TEMPLATE | 请求路径参数 | 在此处配置模板。 |
JSONPath示例如下:
{
"id":"gwrxsJKAnLxSEo4GHhV69q****",
"type":"acs.api.destination",
"endpoint":"acs:api-destination:cn-hangzhou:11860954742****:name/api-key-test",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"resourceKey":"Name",
"form":"CONSTANT",
"value":"api-key-test"
},
{
"resourceKey":"HeaderParameters",
"form":"TEMPLATE",
"value":"{\"headerKey1\":\"Content-Type\",\"headerValue1\":\"multipart/form-data\",\"headerKey2\":\"name\",\"headerValue2\":\"$.data.name\",\"headerKey3\":\"$.data.number\",\"headerValue3\":\"name\"}",
"template":"{\"${headerKey1}\":\"${headerValue1}\",\"${headerKey2}\":\"${headerValue2}\",\"${headerKey3}\":\"${headerValue3}\"}"
},
{
"resourceKey":"BodyParameters",
"form":"TEMPLATE",
"value":"{\"bodyKey1\":\"name\",\"bodyValue1\":\"$.data.name\"}",
"template":"{\"${bodyKey1}\":\"${bodyValue1}\"}"
},
{
"resourceKey":"QueryStringParameters",
"form":"TEMPLATE",
"value":"{\"queryKey1\":\"name\",\"queryValue1\":\"$.data.name\",\"queryKey2\":\"$.data.name\",\"queryValue2\":\"name\"}",
"template":"{\"${queryKey1}\":\"${queryValue1}\",\"${queryKey2}\":\"${queryValue2}\"}"
}
]
}
云工作流
当事件目标选择为云工作流(CloudFlow)时,元数据参数中的Type为acs.fnf
,Endpoint格式为acs:fnf:${region}:${AccountId}:flow/${flow}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
FlowName | 是 | CONSTANT | 流程名称。 | 无 |
ExecutionName | 否 |
| 执行名称。 | 事件转换的格式。共有以下四种类型:
|
Input | 否 | JSONPATH | 执行输入信息。 | 请参见ExecutionName的TEMPLATE。 |
RoleName | 是 | CONSTANT | 角色配置。 | 无 |
JSONPath示例如下:
{
"id":"KLUGLVJeuWDw1bIJ6lgURl****",
"type":"acs.fnf",
"endpoint":"acs:fnf:cn-hangzhou:118609547428****:flow/${flow}",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"value":"serverless",
"resourceKey":"FlowName",
"form":"CONSTANT"
},
{
"value":"$.data",
"resourceKey":"ExecutionName",
"form":"JSONPATH"
},
{
"value":"$.data",
"resourceKey":"Input",
"form":"JSONPATH"
},
{
"value":"AliyunEventBridgeFNF-FZwEeE****",
"resourceKey":"RoleName",
"form":"CONSTANT"
}
]
}
容器服务Kubernetes
当事件目标选择为容器服务 Kubernetes 版时,元数据参数中的Type为acs.k8s
,Endpoint值为kubernetes
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
KubeConfig | 是 | CONSTANT | 集群配置文件。 | 无 |
YamlContent | 是 | CONSTANT | Yaml配置。 | 事件转换的格式。共有以下四种类型:
|
Network | 是 | CONSTANT | 网络访问。 | 无 |
QPSLimit | 是 | CONSTANT | 限流配置。 | 无 |
JSONPath示例如下:
{
"id":"Grdzk1cR4DNjmHa0oPJp8j****",
"type":"acs.k8s",
"endpoint":"kubernetes",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"form":"CONSTANT",
"value":"PublicNetwork",
"resourceKey":"Network"
},
{
"form":"CONSTANT",
"value":5,
"resourceKey":"QPSLimit"
},
{
"form":"CONSTANT",
"value":"test1",
"resourceKey":"KubeConfig"
},
{
"form":"CONSTANT",
"resourceKey":"YamlContent",
"value":"test2"
}
]
}
Serverless应用引擎
当事件目标选择为Serverless 应用引擎时,元数据参数中的Type为acs.sae
,Endpoint格式为http://sae.cn-huhehaote.aliyuncs.com/pop/v1/sam/job/execJob
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
RegionId | 是 | CONSTANT | 地域ID。 | 事件转换的格式。共有以下四种类型:
|
AppId | 是 | CONSTANT | 任务模板ID。 | 请参见RegionId的template。 |
EventId | 是 | JSONPATH | 事件ID。 | 请参见RegionId的template。 |
Parameters | 是 | CONSTANT | execjob的CommandArgs Envs参数。 | 请参见RegionId的template。 |
JSONPath示例如下:
{
"id":"xp0dEW4mVbS5tDQzIBiZrY****",
"type":"acs.sae",
"endpoint":"http://sae.cn-huhehaote.aliyuncs.com/pop/v1/sam/job/execJob",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"value":"cn-huhehaote",
"resourceKey":"RegionId",
"form":"CONSTANT"
},
{
"value":"3F2504E0-4F89-11D3-9A0C-0305E82C****",
"resourceKey":"AppId",
"form":"CONSTANT"
},
{
"value":"$.id",
"resourceKey":"EventId",
"form":"JSONPATH"
},
{
"value":"[\"a\",\"b\"]",
"resourceKey":"Parameters",
"form":"CONSTANT"
}
]
}
事件分析EventBridge
当事件目标选择为事件分析EventBridge时,元数据参数中的Type为acs.eventbridge.olap
,Endpoint格式为${SchemaURI}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
UseSchema | 是 | CONSTANT | 绑定映射方式。取值如下:
| 无 |
SchemaGroup | 是 | CONSTANT | Group名称。 | 无 |
SchemaID | 是 | CONSTANT | Schema标识。 | 无 |
SchemaVersion | 是 | CONSTANT | Schema版本。 | 无 |
JSONPath示例如下:
{
"id":"DLuVyP3JcAAb3q2CibqZI6****",
"type":"acs.eventbridge.olap",
"endpoint":"${SchemaURI}",
"pushSelector":"PARAM_TRANSFORMER",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"value":"FromRule",
"resourceKey":"UseSchema",
"form":"CONSTANT"
},
{
"value":"DEFAULT_SCHEMA_GROUP",
"resourceKey":"SchemaGroup",
"form":"CONSTANT"
},
{
"value":"test",
"resourceKey":"SchemaID",
"form":"CONSTANT"
},
{
"value":"1",
"resourceKey":"SchemaVersion",
"form":"CONSTANT"
}
]
}
数据总线DataHub
当事件目标选择为数据总线 DataHub时,元数据参数中的Type为acs.datahub
,Endpoint格式为acs:datahub:${region}:${AccountId}:project/${project}/topic/${topic}
,ParamList中的resourceKey字段含义如下表所示。
resourceKey | 是否必传 | form | value | template |
Project | 是 | CONSTANT | 项目名称。 | 无 |
Topic | 是 | CONSTANT | Topic名称。 | 无 |
TopicType | 是 | CONSTANT | Topic的数据类型。取值如下:
| 无 |
TopicSchema | 当TopicType为TUPLE时,此参数必传。TopicType为BLOB时,无需传递此参数。 | TEMPLATE | TopicSchema。 | TEMPLATE。示例值如下:
其中template中ki(i=1,2,3,...)表示topic第i个字段,对应值为value中定义变量,可以填写部分事件或者常量 。 |
RoleName | 是 | CONSTANT | 角色配置。 | 无 |
JSONPath示例如下:
{
"id":"ZXoGuhjAT5UfqngBPapXro****",
"type":"acs.datahub",
"endpoint":"acs:datahub:cn-hangzhou:175299981560****:project/demo_project/topic/demo_topic",
"errorsTolerance":"ALL",
"pushRetryStrategy":"BACKOFF_RETRY",
"paramList":[
{
"Form":"CONSTANT",
"Value":"demo_project",
"ResourceKey":"Project"
},
{
"Form":"CONSTANT",
"Value":"demo_topic",
"ResourceKey":"Topic"
},
{
"Form":"CONSTANT",
"Value":"TUPLE",
"ResourceKey":"TopicType"
},
{
"Form":"TEMPLATE",
"Value":"{\"k1-0\":\"1\",\"k2-1\":\"2\",\"k3-2\":\"3\"}",
"Template":"{\"k1\":\"${k1-0}\",\"k2\":\"${k2-1}\",\"k3\":\"${k3-2}\"}",
"ResourceKey":"TopicSchema"
},
{
"Form":"CONSTANT",
"Value":"AliyunEventBridgeDataHubRole-2HwuVf****",
"ResourceKey":"RoleName"
}
]
}