Since | 19.0 |
このノードは、URLに対してHTTPリクエストを実行するワークアイテムを作成します。 そのレスポンスデータは、ワークアイテムアトリビュートまたはディスク上の外部ファイルのどちらかに保存されます。
パラメータ ¶
URL Request ¶
Generate When
このノードがワークアイテムを生成するタイミングを決めます。 このノードがどの生成モードを必須にしているのか、もしくは、ワークアイテムを動的に生成させる必要があるのかどうか分からないのであれば、通常では、これを“Automatic”のままに設定してください。
All Upstream Items are Generated
このノードは、すべての入力ノードが自身のワークアイテムを生成した時にワークアイテムを生成します。
All Upstream Items are Cooked
このノードは、すべての入力ノードが自身のワークアイテムをクックした時にワークアイテムを生成します。
Each Upstream Item is Cooked
このノードは、入力ノード内のワークアイテムがクックされる度にワークアイテムを生成します。
Automatic
入力ノードの生成モードに基づいて生成モードが選択されます。 入力ノードのどれかがその入力のクック時にワークアイテムが生成されている場合、このノードには Each Upstream Item is Cooked が設定されます。 そうでない場合、 All Upstream Items are Generated が設定されます。
Perform Request During
ワークアイテム生成時またはワークアイテムクック時のどちらでHTTPリクエストを実行するのかを決めます。 ワークアイテム生成時にHTTPリクエストを実行する場合、すべてのHTTPリクエストが完了するまで生成ステップはブロックされます。 つまり、HTTPリクエストが結果を返さない限り、ノードにワークアイテムが 追加されません 。
Request ¶
以下のパラメータを使用することで、URL、クエリの引数、リクエストタイプ(GET、POSTなど)を構成することができます。
HTTP Request Type
実行するHTTPリクエストの タイプ を指定します。 次のリクエストタイプから選択することができます:GET, POST, PUT, HEAD, DELETE。
Custom User Agent
有効にすると、このパラメータの値がこのノード内のワークアイテムによって作成されたHTTPリクエストのユーザエージェント文字列として追加されます。
Request Timeout
有効にすると、このノード内のワークアイテムによって作成されたHTTPリクエストは、指定した時間(秒)が過ぎてもレスポンスを受信しなかった場合に失敗します。
Allow Direction
有効にすると、HTTPリクエストは、別のHTTPステータスコードを出すエンドポイントに到達しない限りリダイレクトに従います。 無効にすると、HTTPリクエストは、リダイレクトに 従わず 、30xステータスコードを返します。
Base URL
リクエストのベースURLを指定します。
例えば、https://www.sidefx.com
です。
Set URL Parameters
このノードがベースURLに追加パラメータを追加する方法を決めます。
None
何もURLパラメータを追加しません。
From Attributes
Attribute Pattern パラメータ内のパターンを使って指定されたアトリビュート名/値に基づいてURLパラメータが設定されます。
From Multiparm
Num URL Parameters マルチパラメータを使用して明示的にパラメータを追加します。
Attribute Pattern
URLクエリパラメータとして追加するアトリビュートを指定します。
このパラメータは、 Set URL Parameters が From Attributes に設定されている場合にのみ利用可能です。
Num URL Parameters
ベースURLに追加するURLクエリパラメータの数を指定します。
このパラメータは、 Set URL Parameters が From Multiparm に設定されている場合にのみ利用可能です。
Name
URLクエリパラメータの名前。
Value
URLクエリパラメータの値。
Payload ¶
以下のパラメータを使用することで、 POST や PUT のリクエストを作成する時に、リクエストと一緒に送信されるペイロードデータを構成することができます。
Set Payload From
ペイロードデータの指定方法を決めます。
None
リクエストと一緒にペイロードデータを送信しません。
Attribute
Attribute Nameパラメータで指定されたワークアイテムアトリビュートの内容に基づいてペイロードデータが設定されます。
File
ディスク上のファイルからペイロードデータを読み込みます。
Custom String
ペイロードがCustom Payloadパラメータで指定されたカスタム文字列値に設定されます。
Attribute Name
上流のワークアイテム上のペイロードデータを含んだアトリビュートの名前を決めます。
このパラメータは、 Set Payload From が Attribute に設定されている場合にのみ利用可能です。
File Type
ファイルパスの指定方法を決めます。
このパラメータは、 Set Payload From が File に設定されている場合にのみ利用可能です。
Upstream Output File
上流のワークアイテムの出力ファイルリストからファイルが読み込まれます。 このファイルリストは、 File Tag パラメータで指定します。
Custom File Path
File Path パラメータのカスタム値でファイルが指定されます。
File Tag
上流の出力ファイルを読み込む時に使用するファイルタグを決めます。
このパラメータは、 File Type が Upstream Output File に設定されている場合にのみ利用可能です。
Multipart Names
同じ File Tag が関連付けられた上流ファイルが複数存在し得ます。 このパラメータを有効にすれば、HTTPリクエストは、このパラメータで指定された値パターンで決定されたパート名を使用して、そのようなファイルをマルチパートリクエストとしてPOSTします。
このパラメータは、 File Type が Upstream Output File に設定されている場合にのみ利用可能です。
File Pattern
ペイロードデータのファイルパスを決めます。
このパラメータは、 File Type が Custom File Path に設定されている場合にのみ利用可能です。
Custom Payload
このパラメータのフィールドの内容がペイロードデータとしてHTTPリクエストに追加されます。
このパラメータは、 Set Payload From が Custom String に設定されている場合にのみ利用可能です。
Convert Payload to Object
有効な時、ペイロードの内容がPythonオブジェクトに変換されます。
Response ¶
以下のパラメータを使用することで、リクエストからのレスポンスデータの保存方法を設定することができます。
Save Response Data To
レスポンスデータの保存方法と保存先を決めます。
None
リクエストからのレスポンスデータが破棄されます。
Attribute
HTTPリクエストを作成したワークアイテムの文字列アトリビュートにレスポンスデータが直接保存されます。
File
ワークアイテムの出力ファイルとして追加されるディスク上のファイルにレスポンスデータが保存されます。
Save As
レスポンスデータの保存方法を決めます。
このパラメータは、 Save Response Data To が Attribute に設定されている場合にのみ利用可能です。
Sting
レスポンスデータが文字列アトリビュートとして保存されます。
JSON Object
レスポンスデータがJSONとして再解釈され、PyObjectアトリビュートとして保存されます。
Attribute Name
ワークアイテムアトリビュートの名前を指定します。
このパラメータは、 Save Response Data To が Attribute に設定されている場合にのみ利用可能です。
File Path
レスポンスの保存先のファイルパスを指定します。 このパスは出力ファイルとしてワークアイテムにも追加されます。
このパラメータは、 Save Response Data To が File に設定されている場合にのみ利用可能です。
File Tag
File Path の出力ファイルに関連付けるファイルタグを指定します。
このパラメータは、 Save Response Data To が File に設定されている場合にのみ利用可能です。
Automatic
このノードは、ファイルの拡張子に基づいてタグを検出します。
Custom
Custom File Tag を使用します。
Custom File Tag
レスポンスデータをファイルとして保存する際のワークアイテムの出力タグを指定します。
このパラメータは、 File Tag が Custom Tag に設定されている場合にのみ利用可能です。
Save as Binary
有効にすると、レスポンスデータをファイルに保存する際に、出力ファイルがバイナリとして扱われます。
Stream Response Data
有効にすると、レスポンスデータは、リクエストを処理するリモートサーバーからその保存場所にストリーミングされます。 無効にすると、レスポンスデータ全体を必ずメモリに読み込んだ後でないとそのデータを保存することができません。
SSL Verification ¶
以下のパラメータを使用することで、HTTPS URLにリクエストを行なう時に実行されるSSL証明書の検証を設定することができます。
Verify SSL Certificate
HTTPSリクエストを行なう時にSSL証明書の検証を実行するかどうかを決めます。
Custom Cert File
証明書を検証するために信頼できるCA証明書を含んだカスタムファイルのパスを指定します。
Client Cert Type
カスタムのクライアント側証明書の指定方法を決めます。
None
証明書を指定しません。
Single File
単一の.pem
ファイルで証明書を指定します。
Cert/Key Pair
秘密鍵と証明書を含んだペアで証明書を指定します。
Error Handling ¶
以下のパラメータは、このノードがリクエストエラーを処理する方法を決めます。
On Request Failure
リクエストが失敗した場合のその報告方法を決めます。
Ignore
リクエストの失敗を報告しません。
Report Warning
リクエストの失敗を警告として報告します。
Report Error
リクエストの失敗をエラーとして報告します。
Status Code Attrib
有効にすると、リクエストからのHTTPステータスコードが、指定されたアトリビュートに格納されます。
Save Response Headers
有効にすると、リクエストからのレスポンスヘッダが、ワークアイテム上のアトリビュートに格納されます。
Retry Failed Requests
有効にすると、失敗したリクエストは、成功するか最大試行回数に到達するまで試行されます。
Max Retries
Retry Failed Requests が有効な時、このパラメータは、失敗したリクエストの最大試行回数を決めます。
Retry Backoff
試行の間合い(秒)。
試行の間合いに実際に使用される式はbackoff * 2^(num_failures-1)
です。
失敗する度に待ち時間が指数関数的に長くなります。
Retry Status Codes
試行されるHTTPステータスコードをスペースまたはカンマで区切ったリスト。
Schedulers ¶
TOP Scheduler Override
このパラメータは、このノードのTOPスケジューラを上書きします。
Schedule When
有効にすると、このパラメータを使用して、このノードのどのワークアイテムをスケジュールに組むのかを決めるエクスプレッションを指定することができます。 そのエクスプレッションが指定されたワークアイテムに対して0を返すと、そのワークアイテムはスケジューラに組まれずに、即座にクック済みとしてマークされます。 そのエクスプレッションが0以外の値を返すと、そのワークアイテムは従来どおりにスケジュールに組まれます。
Work Item Label
このノードがワークアイテムにどのようにラベルを付けるのかを決めます。 このパラメータによって、固有でないラベル文字列をワークアイテムに割り当てることができ、そのラベルを使用してアトリビュートパネル、タスクバー、スケジューラジョブ名のワークアイテムを区別することができます。
Use Default Label
このノード内のワークアイテムは、TOPネットワークからデフォルトのラベルを使用します。 デフォルトが設定されていない場合は、それらのワークアイテムにはラベルは付きません。
Inherit From Upstream Item
ワークアイテムは親ワークアイテムのラベルを継承します。
Custom Expression
ワークアイテム毎に評価される Label Expression カスタムエクスプレッションをワークアイテムのラベルに設定します。
Node Defines Label
ワークアイテムのラベルをこのノードの内部ロジックで定義します。
Label Expression
有効にすると、このパラメータを使用して、このノードで作成されたワークアイテムに独自のラベルを指定することができます。
このパラメータには、ワークアイテムアトリビュートの参照またはビルトインのプロパティを含めたエクスプレッションを使用することができます。
例えば、$OS: @pdg_frame
は、フレーム値に基づいて各ワークアイテムのラベルを設定します。
Work Item Priority
このパラメータは、現行スケジューラがこのノード内のワークアイテムの優先度を設定する方法を決めます。
Inherit From Upstream Item
ワークアイテムは、親ワークアイテムの優先度を継承します。ワークアイテムに親ワークアイテムがなければ、その優先度は0に設定されます。
Custom Expression
ワークアイテムの優先度は、 Priority Expression の値に設定されます。
Node Defines Priority
ワークアイテムの優先度は、このノード自身の内部優先度計算に基づいて設定されます。
このオプションは、 Python Processor TOP, ROP Fetch TOP, ROP Output TOPのノードでのみ利用可能です。 これらのノードは、各自のノードロジックで実装された優先度設定スキームを定義しています。
Priority Expression
このパラメータには、ワークアイテムの優先度を設定するためのエクスプレッションを指定します。 このエクスプレッションは、ノード内のワークアイム毎に評価されます。
このパラメータは、 Work Item Priority が Custom Expression に設定されている場合にのみ利用可能です。