このトピックでは、DataWorks OpenAPI の概要 (基本情報、使用制限、課金、呼び出し方法など) について説明します。
基本情報
|
バージョン |
OpenAPI ポータル |
サポート対象 API |
サポート対象リージョン |
|
2024-05-18 (新しいバージョン) |
China (Hangzhou)、China (Shanghai)、China (Shenzhen)、China (Beijing)、China (Zhangjiakou)、China North 2 Ali Gov 1、China East 2 Finance、China (Chengdu)、China (Hong Kong)、Singapore、Indonesia (Jakarta)、US (Silicon Valley)、US (Virginia)、Germany (Frankfurt)、UK (London)、Japan (Tokyo)、Malaysia (Kuala Lumpur) 重要
Data Studio 関連 API に関する注意事項：
新しい [Data Studio] を使用しているかどうかを確認し、対応する OpenAPI バージョンを選択してください。誤ったバージョンを選択すると、クエリが失敗したり、予期しない結果が返されたりする可能性があります。 |
||
|
2020-05-18 (レガシーバージョン) |
制限事項
-
モジュールの OpenAPI のエディション要件は、モジュール自体の要件と一致します。
-
DataWorks OpenAPI の呼び出しを制御し、システムの安定性を確保するために、API は読み取りまたは書き込みに分類しています。DataWorks のエディションごとに、特定の QPS (1 秒あたりのクエリ数) 制限があります。Basic Edition には 1 日あたりの呼び出し制限もありますが、Standard Edition、Professional Edition、Enterprise Edition にはありません。各エディションには、月間無料呼び出しクォータと、クォータを超えた呼び出しに対する従量課金のルールもあります。次の表にこれらの詳細をまとめます。
エディション
QPS 制限
1 日あたりの呼び出し制限
月間無料呼び出しクォータ
無料クォータ超過後の従量課金
Basic Edition
すべての API の合計 QPS ≤ 5
1 日あたりの API 呼び出し合計 ≤ 100
3,100 回/月
呼び出し制限が適用されます。追加の従量課金はサポートされていません。
Standard Edition
1 日あたりの呼び出し制限なし
100,000 回/月
0.05 米ドル/10,000 回
Professional Edition
1 日あたりの呼び出し制限なし
500,000 回/月
0.05 米ドル/10,000 回
Enterprise Edition
-
読み取り API の合計 QPS ≤ 50
-
書き込み API の合計 QPS ≤ 20
1 日あたりの呼び出し制限なし
1,000,000 回/月
0.05 米ドル/10,000 回
DataWorks の基盤となるスケジューリングタスクは、OpenAPI 操作を通じて実行されません。OpenAPI 呼び出しクォータを使い切っても、時間指定スケジューリング タスクやバッチタスクの正常な実行には影響しません。Python ノードや PyODPS ノードなど、OpenAPI 操作自体を呼び出すタスクのみが影響を受けることがあります。本番環境のスケジュールされたインスタンスは事前に生成されるため、API 呼び出しクォータの対象にはなりません。
重要-
API の QPS と呼び出し回数は、各リージョンにおける各 Alibaba Cloud アカウント (RAM ユーザーを含む) の累計値として計算されます。
-
QPS 制限を超えた場合、または Basic Edition の 1 日あたりの呼び出し制限を超えた場合、呼び出しは失敗します。このため、呼び出しの同時実行数と頻度を制御してください。
-
Basic Edition の場合、成功した API 呼び出しと失敗した API 呼び出しの両方が、1 日あたりの呼び出し制限にカウントされます。Standard Edition、Professional Edition、Enterprise Edition には 1 日あたりの呼び出し制限はありません。また、失敗した呼び出しは課金の対象となる呼び出し回数にカウントされません。月間無料呼び出しクォータと従量課金のルールにご注意ください。
-
各 API の読み取り/書き込みタイプは、その名前から判断できます。たとえば、
CreateFileは 書き込み API であり、ListFilesは 読み取り API です。
-
前提条件
OpenAPI を呼び出す前に、AliyunDataWorksFullAccess 権限が付与されていることを確認してください。付与されていない場合、権限不足により OpenAPI の呼び出しが失敗することがあります。詳細については、「AliyunDataWorksFullAccess 権限の付与」をご参照ください。
課金
各エディションの月間無料呼び出しクォータ、クォータ超過後の従量課金単価、QPS 制限、および 1 日あたりの呼び出し制限は、上記の「制限事項」セクションの表にまとめられています。以下では、課金メトリックと考慮事項に関する詳細を説明します。
-
毎月、各リージョンの各 Alibaba Cloud アカウント (RAM ユーザーを含む) に、OpenAPI の無料呼び出しクォータが付与されます。月間無料クォータは DataWorks のエディションによって異なります。
-
Basic Edition は、1 日あたりの呼び出し制限と月間無料呼び出しクォータの両方の対象となります (詳細については、上記の「制限事項」をご参照ください)。制限を超えると呼び出しは拒否され、従量課金はサポートされていません。Standard Edition と Professional Edition には 1 日あたりの呼び出し制限はなく、それぞれに月間無料呼び出しクォータがあります (上記の「制限事項」セクションの表をご参照ください)。無料クォータを超えた後は、従量課金が適用されます。単価と環境ごとの違いについては、「リソースコストにおける OpenAPI の課金」をご参照ください。Enterprise Edition には 1 日あたりの呼び出し制限はなく、無料クォータを使い切った後も同じ従量課金ルールが適用されます。
-
DataWorks の Standard Edition、Professional Edition、Enterprise Edition では、月間無料呼び出しクォータを使い切った後も、従量課金で API 呼び出しを継続できます。国際サイトでは、ドキュメントに記載されている単価と課金ルールが適用されます。詳細については、「リソースコスト」をご参照ください。実際の課金額は、最終的な請求書に表示される価格に準じます。
OpenAPI の呼び出し方法
Alibaba Cloud OpenAPI の詳細については、「Alibaba Cloud OpenAPI」をご参照ください。
呼び出し方法
|
呼び出し方法 |
サポート状況 |
説明 |
|
SDK (推奨) |
サポート済み |
DataWorks SDK でサポートされている言語と依存関係のインストール方法については、「DataWorks SDK」をご参照ください。 |
|
サポート済み |
ネイティブ HTTP 呼び出しでは、署名アルゴリズムを実装し、カスタムリクエストを構築して HTTP 呼び出しを開始する必要があります。署名メカニズムの詳細については、「署名メカニズム」をご参照ください。 |
呼び出し例
API スタイル
RPC スタイル。
エンドポイント
レイテンシーを最小限に抑えるには、お使いの DataWorks ワークスペースが配置されているリージョンに対応するエンドポイントを選択してください。 たとえば、中国 (張家口) の VPC エンドポイントは dataworks-vpc.cn-zhangjiakou.aliyuncs.com です。 詳細については、「エンドポイント (2024-05-18)」および「エンドポイント (2020-05-18)」をご参照ください。
OpenAPI 使用状況の表示
Open Platform を使用して、無料クォータの消費量、呼び出し回数、呼び出し詳細など、OpenAPI の使用状況を表示できます。詳細については、「OpenAPI 使用状況の表示」をご参照ください。