DataWorks OpenAPI の呼び出し - DataWorks - Alibaba Cloud ドキュメントセンター

このトピックでは、DataWorks OpenAPI の概要（基本情報、使用上の制限、課金、および呼び出し方法）について説明します。

基本情報

バージョン	OpenAPI ポータル	サポートされる API	サポートリージョン
2024-05-18（新バージョン）	OpenAPI ポータル	サポートされる API の一覧	中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (北京)、中国 (張家口)、中国北部 2 Ali Gov、中国東部 2 Finance、中国 (成都)、中国 (香港)、シンガポール、インドネシア (ジャカルタ)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、イギリス (ロンドン)、日本 (東京)、マレーシア (クアラルンプール) 重要 Data Studio 関連 API の注意事項：新しい Data Studio を使用している場合は、2024-05-18 の OpenAPI バージョンを使用してください。 [新しい Data Studio] を使用しない場合は、2020-05-18 OpenAPI バージョンを使用してください。ご利用の Data Studio が新しいものかどうかを確認し、対応する OpenAPI バージョンを選択してください。誤ったバージョンを選択すると、クエリが失敗したり、予期しない結果が返されたりする可能性があります。
2020-05-18（旧バージョン）	OpenAPI ポータル	サポートされる API の一覧

制限事項

モジュールの OpenAPI に必要なエディションは、モジュール自体の要件と一致します。

DataWorks OpenAPI 呼び出しを適切に管理し、システムの安定性を確保するため、API は読み取りまたは書き込みに分類されています。DataWorks の各エディションには、特定の QPS（クエリ/秒）制限が設定されています。Basic Edition には日次の呼び出し上限も設定されており、Standard Edition、Professional Edition、Enterprise Edition には日次制限はありません。また、各エディションには月間無料クォータがあり、超過分については従量課金が適用されます。以下の表に詳細をまとめます。

エディション	QPS 制限	日次呼び出し上限	月間無料クォータ	従量課金価格
Basic Edition	すべての API の合計 QPS：≤5	1 日あたりの API 呼び出し回数合計：≤100	3,100 回/月	呼び出し制限の対象です。従量課金はサポートされていません。
Standard Edition		日次 API 呼び出し回数：無制限	100,000 回/月	10,000 回あたり USD 0.05
Professional Edition		日次 API 呼び出し回数：無制限	500,000 回/月	10,000 回あたり USD 0.05
Enterprise Edition	読み取り API の合計 QPS：≤50 書き込み API の合計 QPS：≤20	日次 API 呼び出し回数：無制限	1,000,000 回/月	10,000 回あたり USD 0.05

重要

API の QPS および呼び出し回数は、各リージョンにおける Alibaba Cloud アカウントおよびその RAM ユーザーの累計値として計算されます。
QPS 制限を超えた場合、または Basic Edition の日次呼び出し上限に達した場合、それ以降の呼び出しは失敗します。これらの制限を超えないよう、呼び出しの同時実行数および頻度を適切に管理してください。
Basic Edition では、成功・失敗を問わずすべての API 呼び出しが日次呼び出し上限にカウントされます。Standard、Professional、Enterprise エディションには日次呼び出し上限がなく、月間無料クォータには成功した呼び出しのみがカウントされます。無料クォータの使用状況および従量課金ルールを確認してください。
API の種類（読み取りまたは書き込み）は、その名前から判断できます。たとえば、CreateFile は 書き込み API であり、ListFiles は 読み取り API です。

前提条件

OpenAPI を呼び出す前に、権限不足による失敗を防ぐため、AliyunDataWorksFullAccess 権限を付与されていることを確認してください。詳細については、「ユーザー権限」をご参照ください。

無料クォータおよび課金方法

各エディションの月間無料クォータ、クォータ超過時の従量課金価格、QPS や日次呼び出し回数などの制限は、「制限事項」セクションの表にまとめられています。本セクションでは、課金計算およびその他の重要な注意事項について補足説明します。

重要

各 Alibaba Cloud アカウント（RAM ユーザーを含む）は、各リージョンで OpenAPI 呼び出しの月間無料クォータを取得します。無料クォータは DataWorks のエディションによって異なります。
Basic Edition は、日次呼び出し上限および月間無料クォータの両方の制限を受けます（「制限事項」を参照）。いずれかの制限を超えると、それ以上の呼び出しはできず、従量課金もサポートされません。Standard および Professional エディション には日次呼び出し上限がなく、月間無料クォータが設定されています（制限事項セクションの概要表を参照）。無料クォータを使い切った後の呼び出しは、従量課金で請求されます。価格の詳細および環境ごとの違いについては、「リソースコストの OpenAPI 課金セクション」をご参照ください。Enterprise Edition には日次呼び出し上限がなく、無料クォータを使い切った後も同じ従量課金ルールが適用されます。
DataWorks の Standard、Professional、Enterprise エディション では、月間無料クォータを使い切った後も、従量課金で引き続き呼び出しを行えます。国際サイトでは、ドキュメントに記載された単位価格および課金ルールが適用されます。詳細については、「リソースコスト」をご参照ください。最終的な請求書の金額が優先されます。

API 呼び出し

説明

Alibaba Cloud OpenAPI の呼び出しに関する詳細情報については、「概要」をご参照ください。

呼び出し方法

呼び出し方法	サポート	説明
Alibaba Cloud SDK（推奨）	はい	DataWorks SDK がサポートするプログラミング言語および依存関係のインストール方法については、「DataWorks SDK」をご参照ください。
ネイティブ HTTP 呼び出し	はい	ネイティブ HTTP 呼び出しを使用する場合は、署名アルゴリズムを実装し、カスタムリクエストを構築する必要があります。署名メカニズムの詳細については、「リクエスト構造および署名」をご参照ください。

呼び出し例

DataWorks SDK（推奨）
HTTP 経由での OpenAPI 呼び出し

API スタイル

DataWorks OpenAPI は RPC スタイルを使用します。

エンドポイント

遅延を最小限に抑えるため、ご利用の DataWorks ワークスペースが配置されているリージョンに対応するエンドポイントを選択してください。たとえば、中国 (張家口) リージョンの VPC エンドポイントは dataworks-vpc.cn-zhangjiakou.aliyuncs.com です。詳細については、「エンドポイント (2024-05-18)」および「エンドポイント (2020-05-18)」をご参照ください。

OpenAPI 使用量

Open Platform を使用して、無料クォータの消費状況、呼び出し回数、スケジューリングの詳細など、OpenAPI の使用量を確認できます。詳細については、「OpenAPI」をご参照ください。