ExecuteSparkWarehouseBatchSQL で Spark SQL バッチタスクを実行 - AnalyticDB for MySQL

操作説明

リージョン公共ネットワークアクセスアドレス：adb.<region-id>.aliyuncs.com。例：adb.cn-hangzhou.aliyuncs.com。
リージョン VPC アクセスアドレス：adb-vpc.<region-id>.aliyuncs.com。例：adb-vpc.cn-hangzhou.aliyuncs.com。

説明

中国 (青島)、中国 (深セン)、中国 (広州)、中国 (香港) からリクエストを送信する際に、409 エラーが発生した場合は、テクニカルサポートにお問い合わせください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:ExecuteSparkWarehouseBatchSQL

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Agency	string	任意	クライアントの名前。	Dataworks。
DBClusterId	string	必須	クラスター ID。	amv-bp11q28kvl688****
ResourceGroupName	string	必須	リソースグループの名前。	test
Query	string	必須	バッチで実行する SQL ステートメント。複数の SQL ステートメントはセミコロン (;) で区切ります。実行エンジンは、同じセッション内で SQL ステートメントを順番に実行します。	CREATE TABLE user(id INT, name STRING); INSERT INTO t VALUE(1, 'Bob'); SELECT * FROM t;
Schema	string	任意	データベースの名前。	adb_demo
ExecuteResultLimit	integer	任意	Object Storage Service (OSS) に書き込むことができる実行結果データの最大量。単位: MB。デフォルト値: 4096。圧縮されたオブジェクトのサイズは推定が困難です。実際に OSS に書き込まれるデータは、指定された値よりも小さくなります。	4096
ExecuteTimeLimitInSeconds	integer	任意	最大実行時間。単位: 秒。SQL ステートメントのセットが送信後に指定された期間内に実行されなかった場合、タイムアウトエラーとしてマークされます。デフォルト値は 360000 秒で、これは 100 時間に相当します。	3600000
RuntimeConfig	string	任意	追加の実行時パラメーター。パラメーターは JSON 形式で指定します。	{ "OSSURL": "oss://testBucketname/" }

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	CBE843D8-964D-5EA3-9D31-822125611B6E
Data	SparkBatchSQL	返されるデータ。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "CBE843D8-964D-5EA3-9D31-822125611B6E",
  "Data": {
    "QueryId": "sq172352176****",
    "QueryState": "RUNNING",
    "QuerySubmissionTime": 1723521767000,
    "QueryStartTime": 1723521767000,
    "QueryEndTime": 1723521767000,
    "Schema": "default",
    "Uid": 0,
    "DBClusterId": "amv-bp17s73f016****",
    "ResourceGroupName": "spark_rg",
    "Query": "SELECT * FROM db.tb",
    "Statements": [
      {
        "ResultUri": "oss://yourbucket/result.json",
        "EndTime": 1723521767000,
        "AppId": "s20240122jsdx****",
        "StatementId": "sq1723521767****-0001",
        "State": "RUNNING",
        "StartTime": 1723521767000,
        "Error": "table is not found",
        "Code": "SELECT 100",
        "Result": "+---+-----+\n|age| name|\n+---+-----+\n| 14|  Tom|\n| 23|Alice|\n+---+-----+"
      }
    ],
    "ErrMessage": "schema is not found"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Spark.InvalidParameter	Invalid parameter value: %s
400	Spark.InvalidState	The object of the operation is in an invalid state: %s
500	Spark.ServerError	The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s
404	Spark.ObjectNotFound	The object is not found. More information: %s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。