このトピックでは、基本情報、制限、課金、呼び出しの説明など、DataWorks API 操作の使用方法に関する注意事項について説明します。
基本情報
バージョン | API 操作ポータル | 対応 API 操作 | 対応リージョン |
バージョン | API 操作ポータル | 対応 API 操作 | 対応リージョン |
2024 年 5 月 18 日（新バージョン API 操作） | 中国 (杭州)、中国 (上海)、中国 (深圳)、中国 (北京)、中国 (張家口)、中国北部 2 Ali Gov、中国東部 2 金融、中国 (成都)、中国 (香港)、シンガポール、インドネシア (ジャカルタ)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、英国 (ロンドン)、日本 (東京)、マレーシア (クアラルンプール) DataStudio 関連の API 操作に関する使用上の注意:
DataStudio のパブリックプレビューに参加しているかどうかによって、API 操作のバージョンを選択する必要があります。不適切なバージョンを選択すると、クエリが失敗したり、予期した結果が得られない場合があります。 | ||
2020 年 5 月 18 日（旧バージョン API 操作） |
制限
DataWorks は、テナント、メタデータ、DataStudio、オペレーションセンターなどに関連するさまざまな API 操作を提供します。 DataWorks モジュールに関連する API 操作には、DataWorks モジュールと同じエディション要件があります。
DataWorks API 操作は、データ読み取り用 API 操作とデータ書き込み用 API 操作に分類され、API 呼び出しを標準化し、システムの安定性を確保します。次の表は、異なる DataWorks エディションにおけるデータ読み取り用 API 操作とデータ書き込み用 API 操作のクエリ/秒 (QPS) 制限と 1 日あたりの最大呼び出し数を示しています。
エディション
QPS 制限
1 日あたりの最大呼び出し数
エディション
QPS 制限
1 日あたりの最大呼び出し数
Basic Edition
すべての API 操作で ≤ 5
≤ 100
Standard Edition
≤ 1,000
Professional Edition
≤ 10,000
Enterprise Edition
データ読み取り用 API 操作で ≤ 50
データ書き込み用 API 操作で ≤ 20
無制限
QPS と API 呼び出し数は、Alibaba Cloud アカウントと、そのアカウント内の RAM ユーザーの各リージョンにおける合計 QPS と合計呼び出し数を累積して計算されます。
QPS または 1 日あたりの呼び出し数が上限を超えると、API 呼び出しは失敗します。呼び出しの同時実行数と開始される API 呼び出し数を制御することをお勧めします。
1 日あたりの最大呼び出し数には、成功した API 呼び出しと失敗した API 呼び出しの数が含まれます。
API 操作がデータ読み取り用かデータ書き込み用かは、API 操作の名前で判断できます。たとえば、
CreateFileはデータ書き込みに使用される API 操作であり、ListFilesはデータ読み取りに使用される API 操作です。
前提条件
API 操作を呼び出す前に、AliyunDataWorksFullAccess ポリシーがアカウントにアタッチされていることを確認する必要があります。これは、権限不足による呼び出しの失敗を防ぎます。詳細については、「ユーザー権限管理」をご参照ください。
無料枠と課金ルール
DataWorks は、暦月ごとに API 呼び出しの無料枠を提供します。無料枠を使い切った後は、従量課金制で課金されます。次の表は、無料枠と課金ルールを示しています。
エディション | 無料枠 | 従量課金料金 |
エディション | 無料枠 | 従量課金料金 |
Basic Edition | 月 3,100 回の呼び出し | API 操作の呼び出しは制限されています。従量課金制はサポートされていません。 |
Standard Edition | 月 31,000 回の呼び出し | |
Professional Edition | 月 310,000 回の呼び出し | |
Enterprise Edition | 月 1,000,000 回の呼び出し | 10,000 呼び出しあたり 0.05 USD |
DataWorks は、各リージョンで暦月ごとに API 呼び出しの無料枠を提供します。この無料枠は、Alibaba Cloud アカウントと、そのアカウント内の RAM ユーザーで共有されます。無料枠は、DataWorks エディションによって異なります。
DataWorks Basic Edition、DataWorks Standard Edition、DataWorks Professional Edition で許可される 1 日あたりの API 呼び出しの最大数は、エディションによって異なります。DataWorks Basic Edition、DataWorks Standard Edition、DataWorks Professional Edition における API 呼び出しの実際の月間クォータは、DataWorks が提供する無料枠よりも少ない場合があります。詳細については、「制限」をご参照ください。
DataWorks Enterprise Edition で提供される無料枠を使い切った後は、従量課金制で課金されます。実際の価格は請求書に記載されている価格が優先されます。
無料枠は、API 操作が正常に呼び出された後にのみ消費されます。無料枠を使い切った後は、従量課金制で課金されます。API 操作の呼び出しに失敗した場合、無料枠は消費されず、課金もされません。
呼び出しの説明
Alibaba Cloud API の詳細については、「OpenAPIの使用」をご参照ください。
呼び出し方法
呼び出し方法 | 対応 | 説明 |
呼び出し方法 | 対応 | 説明 |
Alibaba Cloud SDK (推奨) | はい | DataWorks SDK でサポートされているプログラミング言語と依存関係のインストール方法については、DataWorks SDK をご参照ください。 |
呼び出し例
API スタイル
DataWorks の API 操作は、リモートプロシージャコール (RPC) スタイルで呼び出されます。
エンドポイント
レイテンシを削減するには、DataWorks ワークスペースが存在するリージョンに基づいてエンドポイントを選択する必要があります。たとえば、ワークスペースが中国 (張家口) リージョンの VPC にデプロイされている場合は、エンドポイントとして dataworks-vpc.cn-zhangjiakou.aliyuncs.com を指定します。詳細については、「エンドポイント (2024 年 5 月 18 日)」および「エンドポイント (2020 年 5 月 18 日)」をご参照ください。
API 操作の使用状況を表示する
OpenAPI ページでは、DataWorks が毎月提供する API 呼び出しの無料枠の使用状況と、当月に実行した API 呼び出しの数を確認できます。また、日付範囲を指定して、その範囲内の API 呼び出しの詳細を確認することもできます。詳細については、「OpenAPI」をご参照ください。
