使用GetSparkWarehouseBatchSQL获取Spark批量SQL执行结果-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

接口说明

地域的公网接入地址：adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。
地域的 VPC 接入地址：adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。

说明

如果华北 1（青岛）、华南 1（深圳）、华南 3（广州）、中国香港发起请求时，遇到 409 错误，请联系技术支持。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:GetSparkWarehouseBatchSQL

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
QueryId	string	是	Spark SQ 的 L 执行 ID。	sq2024123*****
DBClusterId	string	否	集群 ID。	amv-uf6485635f***
Agency	string	否	协助记录客户端名称，最长 16 个字符的意义字符串。	DMS

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	3D44EDA0-A9DC-580D-9B5A-019370C075F4
Data	SparkBatchSQL	返回数据。	{'DBClusterId': 'amv-uf6485635fz852mn', 'Statements': [{'Code': 'show databases', 'State': 'FINISHED', 'StatementId': 'sq202501141001sh8e12e080006846-0000', 'Result': '+--------------------+n

示例

正常返回示例

JSON格式

{
  "RequestId": "3D44EDA0-A9DC-580D-9B5A-019370C075F4",
  "Data": {
    "Uid": 0,
    "QuerySubmissionTime": 1723521767000,
    "Query": "SELECT * FROM db.tb",
    "QueryId": "sq172352176****",
    "Schema": "default",
    "QueryEndTime": 1723521767000,
    "DBClusterId": "amv-bp17s73f016****",
    "QueryState": "RUNNING",
    "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",
    "QueryStartTime": 1723521767000,
    "ResourceGroupName": "spark_rg"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	操作对象处于非合法状态。
400	Spark.InvalidParameter	Invalid parameter value: %s	输入参数不正确：%s。
403	Spark.Forbidden	No permissions to access the resources: %s	权限不足，拒绝访问相关资源。您当前申请访问的信息是：%s。
404	Spark.ObjectNotFound	The object is not found. More information: %s	操作对象不存在。关联信息：%s。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。