OpenAPI モジュールを使用すると、DataWorks API オペレーションを呼び出して、アプリケーションを DataWorks と統合し、DataWorks サービスを使用できます。
背景情報
DataWorks は 100 を超える API オペレーションを提供しており、これらを呼び出して DataWorks と対話し、DataWorks サービスを使用できます。たとえば、DataWorks API オペレーションを呼び出して、バッチ操作を実行したり、アプリケーションを DataWorks と統合したりできます。DataWorks は、データ開発を促進し、企業固有の要件を満たすことができます。OpenAPI ページでは、DataWorks が毎月提供する API 呼び出しの無料枠の使用状況と、当月に行った API 呼び出しの回数を表示できます。また、日付範囲を指定して、特定の API 呼び出しの詳細を表示することもできます。DataWorks API オペレーションの詳細については、「概要」をご参照ください。
制限
該当するエディション:
DataWorks モジュールに関連する API オペレーションは、DataWorks モジュールと同じエディション要件を備えています。
該当するリージョン:
中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (北京)、中国 (張家口)、中国北部 2 Ali Gov、中国東部 2 金融、中国 (成都)、中国 (香港)、シンガポール、インドネシア (ジャカルタ)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、英国 (ロンドン)、日本 (東京)、マレーシア (クアラルンプール)
API 呼び出しに関する情報の表示
DataWorks コンソール にログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、 を選択します。[開発者バックエンド] タブが表示されます。
OpenAPI ページが表示されます。このページでは、API 呼び出しに関する情報を表示できます。また、OpenAPI モジュールを使用するためのベストプラクティスも表示できます。
OpenAPI ページの内容
OpenAPI ページでは、次の情報を表示できます。
今月の無料呼び出し枠: 今月の現在の日付までの、DataWorks が毎月提供する API 呼び出しの無料枠の使用状況。DataWorks が毎月提供する API 呼び出しの無料枠は、DataWorks エディションによって異なります。無料枠を使い果たすと、行った API 呼び出しの回数に対して課金されます。詳細については、「概要」をご参照ください。
今月の成功した呼び出し: 今月の現在の日付までに行った API 呼び出しの回数。API 呼び出しの回数は月ごとにカウントされ、毎月 1 日に再カウントされます。
API 呼び出しの詳細: 特定の日付範囲における API 呼び出しに関する情報。これには、API オペレーションが呼び出された日付、API オペレーションの名前、タイプ、レベル、現在の日付に API オペレーションが呼び出された回数、および現在の月に API オペレーションが呼び出された回数が含まれます。API オペレーションのタイプとレベルに基づいて API 呼び出しを検索できます。1 日に呼び出すことができる API オペレーションの最大回数は、DataWorks エディションによって異なります。詳細については、「概要」をご参照ください。
DataWorks OpenAPI のベストプラクティス
OpenAPI ページの「DataWorks OpenAPI のベストプラクティス」セクションには、OpenAPI モジュールを使用するためのベストプラクティスが表示されます。いずれかのプラクティスをクリックすると、関連ドキュメントにリダイレクトされます。このトピックの次のリンクをクリックして、関連ドキュメントにアクセスすることもできます。
API オペレーションの詳細については、「API の概要」をご参照ください。