本文介紹事件目標中的中繼資料參數。
請求參數
參數 | 類型 | 是否必選 | 樣本值 | 描述 |
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,用於授權。 |
DingTalk
當事件目標選擇DingTalk時,中繼資料參數中的Type值為acs.dingtalk
,Endpoint表示配置的DingTalkURL地址,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}"
}
}
]
}
Function Compute
當事件目標選擇Function Compute時,中繼資料參數中的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"
}
]
}
輕量訊息佇列
當事件目標選擇Simple Message Queue (formerly 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 版
當事件目標選擇ApsaraMQ for 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"
}
]
}
Log ServiceSLS
當事件目標選擇Log ServiceSLS時,中繼資料參數中的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" }, ] }
樣本二:網路設定為Virtual Private Cloud
{ "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"
}
]
}
Container ServiceKubernetes
當事件目標選擇為Container Service for 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 App Engine時,中繼資料參數中的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"
}
]
}