SORACOM API アクションは、指定した SORACOM API を SAM ユーザーの権限で実行します。
概要
SORACOM API アクションの説明と有効化の設定を行います。
項目 | 説明 |
---|---|
SORACOM API アクションの名前を入力します。 | |
SORACOM API アクションの概要を入力します。 | |
SORACOM API アクションを有効化する場合は「有効」にします。 |
SORACOM API アクションの設定
CONDITION
に、アクションを実行する条件を指定できます。
- この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例:
event.payload.temp
) や、アクションを追加したチャネルに関するデータを表す式 (例:payload.temp
) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。
CONFIG
SORACOM API アクションを設定します。
項目 | 説明 |
---|---|
実行する API を選択します。API について詳しくは、SORACOM API リファレンス を参照してください。 API によっては選択しても利用できない場合があります以下の API は選択できますが、選択しても利用できません。
API によっては選択肢に表示されない場合があります以下の API は選択できません。
| |
パスに {sim_id} などのプレースホルダーが含まれている場合は更新してくださいたとえば、
| |
HTTP ボディを指定します。指定できる内容は、API によって異なります。詳しくは、SORACOM API リファレンス を参照してください。 Flux アプリが起動するトリガーに関するデータを表す式 (例: HTTP ボディは content-type: application/json で送信されます
| |
注意点をよく読み、理解できたらチェックを入れます。 API の実行に伴い課金が発生することがありますSORACOM API アクションの利用、および API の実行は無料ですが、API を実行した結果、課金が発生することがあります。API の仕様やその結果発生する料金についてよく理解したうえで利用してください。 | |
API を実行する (API の実行権限がある) SAM ユーザーを作成、または選択します。
既存の SAM ユーザーから選択する場合は、[権限設定]、[信頼ポリシー] は更新されませんと を上記のように更新するまでは、SORACOM API アクションは実行されません。 SORACOM API アクションを編集しても SAM ユーザーの設定は更新されませんSORACOM API アクションで実行する API を変更する場合は、すでに設定された SAM ユーザーの設定もあわせて編集するか、SORACOM API アクションを再作成してください。 SAM ユーザーの [SORACOM リソース認証] に SORACOM API アクションの SRN が自動的に追加されますSORACOM API アクションを保存したり更新したりすると、SAM ユーザーの → に、SORACOM API アクションの SRN (Soracom Resource Name) が自動的に追加されます。
に追加された SORACOM API アクションの SRN は、自動的に削除されない場合があります。文字数の制限で保存できなくなった場合は、不要な SRN の割り当てを解除してください。 |
OUTPUT
アクションの出力データの取り扱いを設定します。
項目 | 説明 |
---|---|
「有効」にすると、アクションの出力データを別のチャネルに送信できます。 | |
|
SORACOM API アクションの出力データ
SORACOM API アクションの出力データは、実行した SORACOM API のレスポンスボディです。レスポンスボディは API ごとに異なります。詳しくは、SORACOM API リファレンス を参照してください。
SORACOM API アクションで処理できるレスポンスボディの最大サイズは 8192 バイトです
レスポンスボディが 8192 バイトを超えると、Failed to send a http request. Response too large. Max size: 8192 bytes
というエラーが発生します。limit
パラメータに対応する API など、API のパラメータでレスポンスの内容を設定できる場合は、レスポンスボディが短くなるように設定してください。レスポンスボディを短くできない API の場合は、SORACOM API アクションでは利用できません。