16.20 - Data Mover RESTful API呼び出し - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
16.20
Published
2021年11月
Content Type
ユーザー ガイド
Publication ID
B035-4101-107K-JPN
Language
日本語 (日本)
Data Mover RESTful APIサービスの呼び出しは、次の要素からなります。
  • HTTPSはデフォルトで有効になっています。
  • Data Mover RESTfulインターフェースに対するすべての呼び出しは、呼び出しに成功したかどうかを示すHTTPSステータス コードを返します。

    詳細については、RESTful APIのステータス コードを参照してください。

  • Data Mover RESTfulインターフェースを呼び出すと、情報が応答の本文にJSON形式で格納されて返されることがあります。
  • RESTサービスが実行されているData Moverサーバーを識別するURL。例えばhttps://dmprod:1443/datamover/jobs.dmprodなどがあり、パスの各部分は次を定義します。
    • dmprod – Data MoverサーバーのDNSエイリアス
    • 1443– RESTサービスが待機しているデフォルトのポート
    • /datamover/jobs –参照されているRESTリソース
  • Data Mover RESTful APIに対する各呼び出しは、特定のHTTPSメソッド(GET、POST、PUT、またはDELETE)を使用して行なわれます。同じRESTリソースに別のHTTPSメソッドを使用すると、異なるアクションが実行されます。例:
    • /datamover/jobsにGETを使用した場合は、すべてのData Moverジョブのリストが返されます
    • /datamover/jobsにPOSTを使用した場合は、新しいジョブが作成されます

    Data Mover RESTfulインターフェースに対するすべての呼び出しには、使用しているAPIのバージョンを含む承認ヘッダーを含める必要があります。指定された承認ヘッダーは、キーと値のペアです。キーはAccept、現在のバージョン値はapplication/vnd.com.teradata.datamover-v1.0+jsonです。

  • Data Mover RESTful APIに対する呼び出しには、入力パラメータが必要な場合があります。入力パラメータは、要求の本文で JSON 形式で指定されるか、URL パス自体に示されます。

    URLパスの例として、https://dmprod:1443/datamover/jobs/job-name?outputLevel=4(outputLevel=4はパラメータです)。