OpenAPI モジュールを使用すると、DataWorks の API 操作を呼び出して、アプリケーションを DataWorks と統合し、DataWorks サービスを利用できます。
背景情報
DataWorks OpenAPI は、バッチ操作やシステム統合などのタスクを実行するために呼び出すことができる 100 以上の API 機能を提供します。これにより、データ開発の効率が向上し、企業のカスタム要件を満たすのに役立ちます。また、オープンプラットフォームを使用して、無料クォータの使用状況、呼び出し回数、スケジューリング詳細など、OpenAPI の使用状況に関する情報を簡単に表示することもできます。OpenAPI の詳細については、「DataWorks OpenAPI の概要」をご参照ください。
制限事項
エディション要件：DataWorks は、テナント、メタデータ、データ開発、オペレーションセンターなど、さまざまな機能モジュール向けの OpenAPI を提供します。OpenAPI モジュールに必要な DataWorks エディションは、機能自体に必要なエディションと同じです。
各 OpenAPI エディションには、特定の呼び出し制限があります。詳細については、「OpenAPI の使用」をご参照ください。
各 OpenAPI エディションには、特定の月間無料呼び出しクォータが含まれています。無料クォータを使い切った後は、従量課金制で課金されます。無料クォータと従量課金制の課金方法の詳細については、「無料クォータと課金方法」をご参照ください。
利用可能なリージョン：中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (北京)、中国 (張家口)、北京政務クラウド、中国 (上海) 金融クラウド、中国 (成都)、中国 (香港)、シンガポール、インドネシア (ジャカルタ)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、イギリス (ロンドン)、日本 (東京)、マレーシア (クアラルンプール)。
API 呼び出しに関する情報の表示
DataWorks コンソールにログインします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションウィンドウで、 を選択します。表示されたページで、[オープンプラットフォームへ移動] をクリックします。[開発者バックエンド] タブが表示されます。
OpenAPI ページが表示されます。このページでは、API 呼び出しに関する情報を表示できます。また、OpenAPI モジュールを使用するためのベストプラクティスも表示できます。
OpenAPI ページの内容
OpenAPI ページでは、次の情報を表示できます。
無料 OpenAPI クォータ：当暦月の無料 API クォータの使用状況を表示します。DataWorks のエディションによって、提供される無料呼び出しクォータは異なります。無料クォータを使い切った後は、追加の呼び出しに対して従量課金制で課金されます。詳細については、「DataWorks OpenAPI の概要」をご参照ください。
今月の成功した呼び出し：当月の現在の日付までに行った API 呼び出しの数。API 呼び出しの数は月単位でカウントされ、毎月 1 日に再カウントされます。
OpenAPI 呼び出し詳細：特定の期間の API 呼び出し情報を表示します。情報には、呼び出し日、API カテゴリ、1 日あたりの呼び出し回数、月間合計呼び出し回数が含まれます。API カテゴリで API 情報をフィルターできます。1 日あたりの最大呼び出し回数は、DataWorks のエディションによって異なります。詳細については、「DataWorks OpenAPI の概要」をご参照ください。
DataWorks OpenAPI のベストプラクティス
OpenAPI ページの DataWorks OpenAPI のベストプラクティスセクションには、OpenAPI モジュールを使用するためのベストプラクティスが表示されます。1 つのプラクティスをクリックすると、関連ドキュメントにリダイレクトされます。このトピックの次のリンクをクリックして、関連ドキュメントに移動することもできます。
OpenAPI の詳細については、「OpenAPI の使用」をご参照ください。