このトピックでは、DataWorks OpenAPI の基本情報、制限、課金、および呼び出し手順について説明します。
基本情報
バージョン | OpenAPI ポータル | サポートされている API リスト | サポートされているリージョン |
2024-05-18 (新しい OpenAPI) | 中国 (杭州)、中国 (上海)、中国 (深圳)、中国 (北京)、中国 (張家口)、Alibaba Gov Cloud、中国 (上海) Finance Cloud、中国 (成都)、中国 (香港)、シンガポール、インドネシア (ジャカルタ)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、英国 (ロンドン)、日本 (東京)、およびマレーシア (クアラルンプール) 重要 データ開発関連の OpenAPI の使用上の注意:
[新しいデータスタジオを使用] するかどうかを確認し、対応する OpenAPI バージョンを選択してください。不正なバージョンを選択すると、クエリが失敗したり、期待した結果が得られなかったりする場合があります。 | ||
2020-05-18 (古い OpenAPI) |
制限
DataWorks は、テナント、メタデータ、データ開発、オペレーションセンターなどのさまざまな機能モジュール用の OpenAPI を提供します。OpenAPI のエディション要件は、対応する機能の要件と同じです。
DataWorks OpenAPI 呼び出しを標準化し、システムの安定性を確保するために、OpenAPI は読み取りタイプと書き込みタイプに分類されます。DataWorks のエディションによって、読み取りおよび書き込み OpenAPI の 1 秒あたりのクエリ数 (QPS) 制限と 1 日あたりの呼び出し制限が異なります。詳細は以下のとおりです。
エディション
QPS 制限
1 日あたりの最大呼び出し数
Basic Edition
すべての OpenAPI の合計 QPS ≤ 5
1 日あたりの API 呼び出しの合計数は 100 を超えることはできません。
Standard Edition
1 日あたりの API 呼び出しの合計数は 1,000 を超えることはできません。
Professional Edition
1 日あたりの API 呼び出しの合計数は 10,000 を超えることはできません。
Enterprise Edition
読み取り OpenAPI の合計 QPS ≤ 50
書き込み OpenAPI の合計 QPS ≤ 20
1 日あたりの API 呼び出し数に制限はありません。
重要QPS と呼び出し制限は、各リージョンで Alibaba Cloud アカウントとその RAM ユーザーが行う呼び出しの合計数に適用されます。
QPS または 1 日あたりの呼び出し制限を超えると、呼び出しは失敗します。呼び出しの同時実行数と呼び出し数を適宜制御する必要があります。
成功した呼び出しと失敗した呼び出しの両方が、1 日あたりの呼び出し制限にカウントされます。
OpenAPI の名前から、読み取りタイプか書き込みタイプかを判断できます。たとえば、
CreateFileは書き込み OpenAPI で、ListFilesは読み取り OpenAPI です。
前提条件
OpenAPI を呼び出す前に、権限不足による呼び出しの失敗を防ぐために、AliyunDataWorksFullAccess 権限が付与されていることを確認してください。詳細については、「アクセス制御」をご参照ください。
無料クォータと課金方法
各 OpenAPI バージョンには、毎月の無料呼び出しクォータが含まれています。無料クォータを使い切ると、呼び出しは従量課金制で課金されます。次の表に、無料クォータと従量課金制の料金を示します。
エディション | 無料呼び出しクォータ | 無料クォータ使用後の従量課金料金 |
Basic Edition | 3,100 回/月 | 呼び出し制限が適用されます。従量課金はサポートされていません。 |
Standard Edition | 31,000 回/月 | |
Professional Edition | 310,000 回/月 | |
Enterprise Edition | 1,000,000 回/月 | 10,000 回あたり 0.05 米ドル |
各リージョンで、各 Alibaba Cloud アカウントは毎暦月、無料の OpenAPI 呼び出しクォータを受け取ります。このクォータは、アカウントとその RAM ユーザー間で共有されます。無料クォータは DataWorks のエディションによって異なります。
DataWorks のエディションごとに 1 日あたりの呼び出し制限があるため、Basic、Standard、Professional の各エディションの実際の月間呼び出し数が無料クォータを超えることはありません。したがって、これらのエディションでは従量課金はサポートされていません。詳細については、「制限」をご参照ください。
DataWorks Enterprise Edition の無料クォータを使い切ると、呼び出しは従量課金制で課金されます。請求書の実際の価格が優先されます。
成功した OpenAPI 呼び出しのみが無料クォータを消費し、クォータを使い切った後は従量課金制で課金されます。失敗した OpenAPI 呼び出しは無料クォータを消費せず、課金されません。
呼び出し手順
Alibaba Cloud OpenAPI の使用に関する詳細については、「Alibaba Cloud OpenAPI」をご参照ください。
呼び出しメソッド
呼び出しメソッド | サポート | 説明 |
Alibaba Cloud SDK (推奨) | サポート | DataWorks ソフトウェア開発キット (SDK) でサポートされている言語と依存関係のインストール方法については、「DataWorks SDK」をご参照ください。 |
サポート | ネイティブ HTTP 呼び出しでは、署名アルゴリズムを実装し、カスタムリクエストを構築し、HTTP 呼び出しを開始する必要があります。署名メカニズムの詳細については、「リクエスト構造と署名メカニズム」をご参照ください。 |
呼び出し例
API スタイル
RPC スタイル。
エンドポイント
DataWorks プロジェクトが存在するリージョンに基づいてエンドポイントを選択し、レイテンシを最小限に抑えます。たとえば、中国 (張家口) リージョンの VPC エンドポイントは dataworks-vpc.cn-zhangjiakou.aliyuncs.com です。詳細については、「エンドポイント (2024-05-18)」および「エンドポイント (2020-05-18)」をご参照ください。
OpenAPI の使用状況の表示
オープン プラットフォームを使用して、無料クォータの使用状況、呼び出し回数、スケジューリングの詳細など、OpenAPI の使用状況情報を簡単に取得できます。詳細については、「Open API (OpenAPI)」をご参照ください。