CData Python Connector for REST

Build 25.0.9440

httpopsGet

httpopsGet オペレーションはHTTP GET リクエストを行うAPIScript オペレーションです。

入力パラメータ

以下のように、api:set を使用してオペレーションの入力パラメータを指定できます。 

    <api:set  attr="url"                      value="http://www.example.com/target" />

必要なパラメータ

  • URL：取得するURL。

HTTP

  • IfModifiedSince：検索結果のフィルタとして使用するif-modified-since の日時を指定します（例：Sat, 25 Feb 2006 04:11:47 GMT）。
  • LocalFile：指定した場合、GET の結果がこのファイルに書き込まれます。
  • Header:Name#：リクエストで渡す各カスタムヘッダーの名前。
  • Header:Value#：リクエストで渡す各カスタムヘッダーの値。
  • Cookie:*：リクエストに追加されるべきcookie。
  • タイムアウト：オペレーションの完了の秒単位のタイムアウト。ゼロ（0）はタイムアウトなしを意味します。デフォルト値は60です。
  • Logfile：Exchanged/transferred データがログに記録されたファイル。
  • Verbosity：logfile 入力で指定されたファイルに交換 / 転送されたデータを記録する際に使用する詳細レベル。

認証

  • User：authscheme パラメータがNone 以外に設定されている場合に認証するユーザー名。
  • Password：authscheme パラメータがNone 以外に設定されている場合に認証するパスワード。
  • AuthScheme：使用する認可メカニズム。ユーザーとパスワードが提供された場合のみ適用されます。有効な値はBASIC、DIGEST、NTLM です。デフォルトはBASIC です。
  • KerberosKDC：Kerberos のKDC 設定で、AuthScheme がNEGOTIATE の場合に使用可能。
  • KerberosRealm：Kerberos のRealm 設定で、AuthScheme がNEGOTIATE の場合に使用可能。

OAuth

  • Version：OAuth のバージョン。OAuth を使用してリクエストを認可します。DISABLED、1.0、または2.0の値が使用可能です。デフォルト値はDISABLED です。
  • Token：OAuth のアクセストークン。
  • Token_Secret：アクセストークンシークレット。OAuth 1.0 でのみ利用可能です。
  • Client_Id：OAuth クライアントId。OAuth 1.0 でのみ利用可能です。
  • Client_Secret：OAuth クライアントシークレット。OAuth 1.0 でのみ利用可能です。
  • Sign_Method：OAuth 1.0 で署名を計算する際の署名メソッド。HMAC-SHA1 またはPLAINTEXT が使用可能です。デフォルト値はHMAC-SHA1 です。

プロキシ

  • Proxy_Auto：Windows システム設定からプロキシが検出されるかどうか。これは他のプロキシ設定より優先され、Java では使用できません。ソースはproxy_auto です。TRUE またはFALSE が使用可能です。デフォルト値はFALSE です。
  • Proxy_Server：リクエストで使われるプロキシサーバーのIP アドレスもしくはホスト名。ソースはproxy_server です。
  • Proxy_Port：プロキシサーバーのポート番号。ソースはproxy_port です。
  • Proxy_User：プロキシサーバーに認証するためのユーザーId。ソースはproxy_user です。
  • Proxy_Password：プロキシサーバーに認証するためのパスワード。ソースはproxy_password です。
  • Proxy_AuthScheme：プロキシサーバーの認証スキーム。有効な値はBASIC、DIGEST、NONE、NTLM、およびNEGOTIATE です。デフォルトはBASIC です。
  • Proxy_AuthToken：プロキシ認証トークン。
  • Proxy_SSLType：プロキシサーバーのSSL タイプ。AUTO、ALWAYS、NEVER、またはTUNNEL が使用可能です。デフォルト値はAUTO です。

ファイアウォール

  • Firewall_Server：ファイアーウォールのIP アドレスとホスト名。ソースはfirewall_host です。
  • Firewall_Port：ファイアーウォールのポート番号。ソースはfirewall_port です。
  • Firewall_User：ファイアーウォールに認証するためのユーザーId。ソースはfirewall_user です。
  • Firewall_Password：ファイアーウォールに認証するためのパスワード。ソースはfirewall_password です。
  • Firewall_Type：ファイアーウォールのタイプ。ソースはfirewall_type です。有効な値は、NONE、TUNNEL、SOCKS4、およびSOCKS5 です。デフォルトはNONE です。

その他

  • Internalconfig#：内部コンフィギュレーション設定の設定。
  • Charset：交換 / 転送されるデータの文字セット。デフォルトはUTF-8 です。
  • HTTPVersion：使用するHTTP プロトコルのバージョン。有効な値は1.0および1.1です。デフォルトは1.1です。
  • FollowRedirects：HTTP リダイレクトに従うかどうか。有効な値はTRUE およびFALSE です。デフォルトはTRUE です。
  • SSLCert：サーバーが受け入れ可能なSSL 証明書。他の証明書はすべて拒否されます。これは、完全なPEM 証明書、証明書を含むファイルへのパス、公開鍵、MD5 サムプリント、またはSHA-1 サムプリントの形式を取ることができます。これを指定しない場合は、任意の有効な証明書が受け入れられます。デフォルトはTRUSTED です。
  • SSLClientCert：クライアント証明書のための証明書ストア名。
  • SSLClientCertType：クライアント証明書のストアタイプ。有効な値は、USER、MACHINE、PFXFILE、PFXBLOB、JKSFILE、JKSBLOB、PEMKEY_FILE、PEMKEY_BLOB、PUBLIC_KEY_FILE、PUBLIC_KEY_BLOB、SSHPUBLIC_KEY_BLOB、P7BFILE、P7BBLOB、SSHPUBLIC_KEY_FILE、PPKFILE、PPKBLOB、XMLFILE、およびXMLBLOB です。
  • SSLClientCertPassword：クライアント証明書のパスワード。
  • SSLClientCertSubject：クライアント証明書のサブジェクト。アスタリスクを使用すると、ストア内の最初の証明書が検出されます。

出力パラメータ

  • ssl:issuer：SSL 証明書の発行者。
  • ssl:subject：SSL 証明書のサブジェクト。
  • statuscode：リクエストから返されたHTTP ステータスコード。
  • content：HTTP レスポンスのコンテンツ。
  • cookie:*：レスポンスで返されたCookie。
  • allcookies：単一の文字列として返された、レスポンスからのすべてのCookie。
  • header:*：レスポンスで返されたヘッダー。

例： 

    <api:set attr="URL" value="http://www.example.com/target">
    <api:set attr="Header:Name#" value="x-custom">
    <api:set attr="Header:Value#" value="abcd">

    <api:call op="httpops.post" out="output">
      <api:set attr="temp.data" value="[output.content]">
    </api:call >

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9440