このトピックでは、イベントターゲットのメタデータパラメーターについて説明します。
リクエストパラメーター
|
パラメーター |
型 |
必須 |
例 |
説明 |
|
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 です。ID は現在のルール内で一意である必要があります。 |
|
Type |
String |
はい |
|
イベントターゲットのタイプです。各イベントターゲットの詳細な説明については、以降のセクションをご参照ください。 |
|
Endpoint |
String |
いいえ |
|
配信用のエンドポイントリンクです。各イベントターゲットのエンドポイント形式については、以降のセクションをご参照ください。 |
|
PushRetryStrategy |
String |
はい |
BACKOFF_RETRY |
イベントプッシュ時のリトライポリシーです。有効な値は以下のとおりです。
|
|
DeadLetterQueue |
String |
いいえ |
デッドレターキューです。処理されなかったイベントや、最大リトライ回数を超えたイベントは、デッドレターキューに書き込まれます。サポートされるキューの種類は、Simple Message Queue (旧称:MNS) および ApsaraMQ for RocketMQ です。 |
|
|
Arn |
String |
いいえ |
|
デッドレターキューの Alibaba Cloud リソースネーム (ARN) です。処理されなかったイベントや、最大リトライ回数を超えたイベントは、デッドレターキューに書き込まれます。サポートされるキューの種類は、Simple Message Queue (旧称:MNS) および ApsaraMQ for RocketMQ です。 |
|
ParamList |
List<Param> |
はい |
イベントによって渡されるパラメーターです。 |
|
|
resourceKey |
String |
はい |
body |
送信先サービスのパラメーターです。 |
|
form |
String |
はい |
TEMPLATE |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
value |
String |
はい |
|
変換後のイベントの値です。 |
|
template |
String |
いいえ |
|
イベント変換テンプレートのスタイルです。 |
レスポンスパラメーター
|
パラメーター |
型 |
例の値 |
説明 |
|
RuleARN |
String |
|
イベントルールの ARN です。権限付与に使用されます。 |
DingTalk
DingTalk をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.dingtalk となり、Endpoint パラメーターは設定済みの DingTalk URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
URL |
はい |
CONSTANT |
URL。 |
なし |
|
SecretKey |
はい |
CONSTANT |
シークレットキー。 |
なし |
|
Body |
はい |
TEMPLATE |
TEMPLATE のキーと値を定義します。 |
メッセージ本文のテンプレートを定義します。 |
以下の例は、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 パラメーターは acs:mail:${region}:${uid} 形式の設定済みメールボックス URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
Subject |
はい |
CONSTANT |
件名。 |
なし |
|
AccountName |
はい |
CONSTANT |
送信元アドレス。 |
なし |
|
AddressType |
はい |
CONSTANT |
アドレスタイプ。 |
なし |
|
ReplyToAddress |
はい |
CONSTANT |
返信先アドレス。 |
なし |
|
ToAddress |
はい |
|
受信元アドレス。 |
なし |
|
IsHtmlBody |
はい |
CONSTANT |
本文が HTML 形式かどうかを指定します。有効な値は以下のとおりです。
|
なし |
|
Body |
はい |
TEMPLATE |
TEMPLATE のキーと値を定義します。 |
メッセージ本文のテンプレートを定義します。 |
以下の例は、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",
"ResourceKey":"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 パラメーターは acs:sms:${region}:${uid} 形式の設定済み Short Message Service URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
PhoneNumbers |
はい |
|
携帯電話番号。 |
なし |
|
SignName |
はい |
CONSTANT |
署名名。 |
なし |
|
TemplateCode |
はい |
CONSTANT |
Short Message Service のテンプレートコード。 |
なし |
|
TemplateParam |
はい |
TEMPLATE |
TEMPLATE のキーと値を定義します。 |
メッセージ本文のテンプレートを定義します。 |
以下の例は、JSONPath のサンプルです。
{
"Id":"KD20k9rpqDRXPq0SXXlqeT****",
"Type":"acs.sms",
"Endpoint":"acs:sms:cn-hangzhou:164901546557****",
"ParamList":[
{
"Value":"$.data",
"ResourceKey":"PhoneNumbers",
"Form":"JSONPATH"
},
{
"Value":"[For testing only] Alibaba Cloud Communications",
"ResourceKey":"SignName",
"Form":"CONSTANT"
},
{
"Value":"[For testing only] Alibaba Cloud Communications test template",
"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 パラメーターは acs:fc:${region}:${uid}:services/${serviceName}.${Qualifier}/functions/${functionName} 形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
serviceName |
はい |
CONSTANT |
サービス。 |
なし |
|
functionName |
はい |
CONSTANT |
関数。 |
なし |
|
Body |
はい |
|
関数のメッセージ本文の内容です。TEMPLATE のキーと値を定義します。 |
メッセージ本文のテンプレートを定義します。 |
|
Qualifier |
はい |
CONSTANT |
サービスのバージョンまたはエイリアス。 |
なし |
|
InvocationType |
はい |
CONSTANT |
呼び出しタイプです。有効な値は以下のとおりです。
|
なし |
|
DataFormat |
はい |
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"
},
{
"ResourceKey": "Qualifier",
"Form": "CONSTANT",
"Value": "LATEST"
},
{
"ResourceKey": "InvocationType",
"Form": "CONSTANT",
"Value": "Sync"
},
{
"Value":"$.data.name",
"ResourceKey":"Body",
"Form":"JSONPATH"
},
{
"ResourceKey": "DataFormat",
"Form": "CONSTANT",
"Value": "Object"
}
]
}
ライトウェイトメッセージキュー
Simple Message Queue (formerly MNS) をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.mns.queue となり、Endpoint パラメーターは acs:mns:${region}:${uid}:queues/${queue} 形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
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."
}
]
}
ApsaraMQ for RocketMQ
ApsaraMQ for RocketMQ をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.rocketmq となり、Endpoint パラメーターは acs:mq:${region}:${uid}:/instances/${instanceId}/topic/${topic} 形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
InstanceId |
はい |
CONSTANT |
インスタンス ID。 |
なし |
|
Topic |
はい |
CONSTANT |
Topic。 |
なし |
|
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"
}
]
}
ApsaraMQ for RabbitMQ
ApsaraMQ for RabbitMQ をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.rabbitmq となり、Endpoint パラメーターは acs:amqp:${region}:${uid}:/instances/${instanceId}/vhosts/${vhostName}/exchanges/${exchangeName} 形式の設定済み URL となります。ParamList パラメーターの resourceKey フィールドの説明は、以下に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
InstanceId |
はい |
CONSTANT |
インスタンス ID。 |
なし |
|
Vhost |
はい |
CONSTANT |
仮想マシン。 |
なし |
|
TargetType |
はい |
CONSTANT |
ターゲットタイプ。 説明
Exchange および Queue のいずれか 1 つだけを選択できます。 |
なし |
|
Exchange |
いいえ。ただし、TargetType を Exchange に設定した場合は必須です。 |
CONSTANT |
Exchange モード。 |
なし |
|
Queue |
いいえ。ただし、TargetType を Queue に設定した場合は必須です。 |
CONSTANT 説明
Exchange および Queue のいずれか 1 つだけを選択できます。 |
Queue モード。 |
なし |
|
Body |
はい |
|
メッセージ本文。 |
form を TEMPLATE に設定した場合、ここにテンプレートを設定します。 |
|
MessageId |
いいえ。デフォルトでは、この値は自動生成されます。 |
|
メッセージ ID。 |
form を TEMPLATE に設定した場合、ここにテンプレートを設定します。 |
|
Properties |
いいえ |
|
プロパティ。 |
form を TEMPLATE に設定した場合、ここにテンプレートを設定します。 |
以下の例は、JSONPath のサンプルです。
例 1:宛先タイプ が 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"
}
]
}
例 2:宛先タイプ が 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"
}
]
}
ApsaraMQ for Kafka
ApsaraMQ for Kafka をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.alikafka となり、Endpoint パラメーターは acs:alikafka:${regionId}:${accountId}:topics/${topic} 形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
InstanceId |
はい |
CONSTANT |
Kafka インスタンス ID。 |
なし |
|
Topic |
はい |
CONSTANT |
Topic 名。 |
なし |
|
Value |
はい |
|
メッセージ本文。 |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
Key |
はい |
JSONPATH |
メッセージキー。 |
Value のテンプレートを参照してください。 |
|
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"
}
]
}
Simple Log Service
Simple Log Service (SLS) をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.sls となり、Endpoint パラメーターは acs:sls:${regionId}:${accountId}:project/${project}/logstore/${logstore} 形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
Project |
はい |
CONSTANT |
ログプロジェクトの名前。 |
なし |
|
LogStore |
はい |
CONSTANT |
Logstore の名前。 |
なし |
|
Topic |
いいえ |
|
ログトピック。 |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
Body |
いいえ |
|
ログの内容。 |
Topic のテンプレートを参照してください。 |
|
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 となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
url |
はい |
CONSTANT |
URL。 |
なし |
|
Body |
はい |
|
現在、POST リクエストのボディによるデータ転送のみがサポートされています。ヘッダーまたはクエリを使用するには、「API 宛先の管理」をご参照ください。 |
form が TEMPLATE に設定されている場合、対応するテンプレートをここで設定します。テンプレート内の変数は value から取得されます。 |
|
Network |
はい |
CONSTANT |
ネットワークタイプです。有効な値は以下のとおりです。
|
なし |
|
VPCNameAndId |
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。 |
CONSTANT |
宛先が配置されている VPC の情報です。形式: |
なし |
|
VSwitchesNameAndId |
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。 |
CONSTANT |
宛先が配置されている VPC の vSwitch の情報です。複数の vSwitch をサポートしています。形式は JSON 文字列です。例: |
なし |
|
SecurityGroupNameAndId |
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。 |
CONSTANT |
宛先が配置されている VPC のセキュリティグループの情報です。形式: |
なし |
|
Token |
いいえ。デフォルトでは、このパラメーターは空です。 |
CONSTANT |
署名検証に使用されます。ヘッダーのキーは固定で |
なし |
以下の例は、JSONPath のサンプルです。
例 1:ネットワークタイプ が インターネット の場合
{
"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"
}
]
}
例 2: ネットワークタイプ は VPC です。
{
"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 パラメーターはacs:rds:${region}:${uid}:dbinstance/${dbinstanceid}形式の設定済み URL となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。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
vSwitch 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}形式で設定されます。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。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、セキュリティグループの情報を設定する必要があります。
なし
VpcId
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。
CONSTANT
VPC ID。
なし
VSwitchIds
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。
CONSTANT
vSwitch ID。
なし
SecurityGroupId
いいえ。ただし、Network を PrivateNetwork に設定した場合は必須です。
CONSTANT
セキュリティグループ ID。
なし
例 1:ネットワーク構成 が インターネット の場合
{ "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" } ] }例 2:ネットワーク構成 が VPC (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":"ConnectionStringAndPort", "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} 形式に従います。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
RegionId |
はい |
CONSTANT |
ターゲットリージョン ID。 |
なし |
|
AccountType |
はい |
CONSTANT |
アカウントタイプです。有効な値は以下のとおりです。
|
なし |
|
AccountId |
いいえ。デフォルトでは、現在のアカウントが使用されます。 |
CONSTANT |
宛先アカウント ID。AccountType が SameAccount の場合、このパラメーターを指定する必要はありません。 |
なし |
|
EventBusName |
はい |
CONSTANT |
宛先バスの名前。 |
なし |
|
RAMRoleName |
いいえ。ただし、クロスアカウント配信の場合は必須です。 |
CONSTANT |
付与されたロールの名前。詳細については、「EventBridge へのイベントのルーティング」をご参照ください。AccountType が SameAccount の場合、このパラメーターを指定する必要はありません。 |
なし |
|
Body |
はい |
ORIGINAL。完全なイベントが配信されることを示します。 |
なし。 |
なし |
以下の例は、JSONPath のサンプルです。
例 1:現在のアカウントのイベントバスに書き込む
{
"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"
}
]
}
例 2:別のアカウントのイベントバスに書き込む
{
"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}:name/${APIName} 形式となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
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
CloudFlow をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.fnf となり、Endpoint パラメーターは acs:fnf:${region}:${AccountId}:flow/${flow} 形式となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
FlowName |
はい |
CONSTANT |
フロー名。 |
なし |
|
ExecutionName |
いいえ |
|
実行名。 |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
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 Service for Kubernetes
Container Service for Kubernetes をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.k8s となり、Endpoint パラメーターの値は kubernetes となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
KubeConfig |
はい |
CONSTANT |
クラスター設定ファイル。 |
なし |
|
YamlContent |
はい |
定数 |
YAML 設定。 |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
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 App Engine
Serverless App Engine をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.sae となり、Endpoint パラメーターは http://sae.cn-huhehaote.aliyuncs.com/pop/v1/sam/job/execJob となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
RegionId |
はい |
CONSTANT |
リージョン ID。 |
イベント変換のフォーマットです。4 種類が利用可能です。
|
|
AppId |
はい |
定数 |
ジョブテンプレート ID。 |
RegionId のテンプレートを参照してください。 |
|
EventId |
はい |
JSONPATH |
イベント ID。 |
RegionId のテンプレートを参照してください。 |
|
Parameters |
はい |
CONSTANT |
execjob の CommandArgs と Envs パラメーター。 |
RegionId のテンプレートを参照してください。 |
以下の例は、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:イベント分析
イベント分析をイベントターゲットとして選択した場合、メタデータ内の Type パラメーターの値は acs.eventbridge.olap となり、Endpoint パラメーターは ${SchemaURI} 形式となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
UseSchema |
はい |
CONSTANT |
バインディングとマッピング方法。有効な値は以下のとおりです。
|
なし |
|
SchemaGroup |
はい |
定数 |
グループ名。 |
なし |
|
SchemaID |
はい |
CONSTANT |
スキーマ ID。 |
なし |
|
SchemaVersion |
はい |
CONSTANT |
スキーマバージョン。 |
なし |
以下の例は、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} 形式となります。resourceKey フィールドの説明は、ParamList パラメーター内に記載されています。
|
resourceKey |
必須 |
form |
value |
template |
|
Project |
はい |
CONSTANT |
プロジェクト名。 |
なし |
|
Topic |
はい |
CONSTANT |
Topic 名。 |
なし |
|
TopicType |
はい |
CONSTANT |
Topic のデータ型。有効な値は以下のとおりです。
|
なし |
|
TopicSchema |
TopicType が TUPLE に設定されている場合にのみ必須です。TopicType が BLOB に設定されている場合は必須ではありません。 |
Template |
Topic スキーマ。 |
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"
}
]
}