启动Spark SQL引擎。
接口说明
- 地域的公网接入地址：
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暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | amv-abcd**** |
| ResourceGroupName | string | 是 | 资源组名称。 | spark-rg-name |
| MinExecutor | long | 否 | 执行 SQL 时拉起的最小 Exectuor 数量，配置为 0 意味着当不需要执行 SQL 时不会常驻 Exectuor。取值范围为 0 到 2000，当配置数量超过资源组承载总量时会导致服务启动失败。此处配置值必须小于 MaxExecutor 的配置值。 | 1 |
| MaxExecutor | long | 否 | 执行 SQL 时启动的最大的 Exector 数量。取值范围为 1 到 2000，当配置数量超过资源组承载总量时会导致服务启动失败。 | 10 |
| Jars | string | 否 | 启动 SQL 引擎时需要引入的第三方 JAR 包列表，以逗号分隔的 JAR 包所在的 OSS 地址。 | oss://testBuckname/test.jar,oss://testBuckname/test2.jar |
| SlotNum | long | 否 | 最大槽位数，即最多可以维持多少个 Spark Session 来执行 SQL。取值范围为 1 到 500。 | 100 |
| Config | string | 否 | 启动 Spark SQL Engine 的具体配置，以一个 JSON 来描述 KEY-VALUE 型配置信息。详情请参见Spark Conf 配置。 | { "spark.shuffle.timeout": ":0s" } |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
"Data": {
"AppId": "s202301xxxx",
"State": "SUBMITTED",
"AppName": "SQLEngine1"
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Spark.InvalidParameter | Invalid parameter value: %s | 输入参数不正确。 |
| 400 | Spark.App.ExceedQuotaLimitation | The requested resource exceeds the maximum limit: %s | - |
| 400 | Spark.App.InvalidAppTypeWhenSubmit | The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s. | AppType类型不合法，请参考使用文档指定适合业务的AppType，请关注配置类型：%s。 |
| 400 | Spark.App.InvalidResourceSpec | The requested resource type is not supported:\n %s | - |
| 400 | Spark.App.ParameterConflict | Conflicting parameters submitted:\n %s | - |
| 400 | Spark.App.ResourceNegativeError | The requested resource MUST be positive: %s | - |
| 400 | Spark.Config.InvalidAppFilePath | The main driver file MUST be a valid OSS path. Current is %s. | 主驱动文件地址必须是合法的OSS地址，当前的地址是 %s。 |
| 400 | Spark.Config.invalidConnectors | The spark.adb.connectors configuration is invalid: %s | spark.adb.connectors配置不正确。 |
| 400 | Spark.Config.InvalidDiskConfig | The requested disk mount parameter is invalid: %s | 磁盘挂载配置错误。 |
| 400 | Spark.Config.InvalidHostAliasConfig | The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local | 域名映射配置错误。 |
| 400 | Spark.Config.InvalidLogOssPath | The OSS address for log storage is illegal: %s | 存储日志的OSS地址非法。 |
| 400 | Spark.Config.InvalidRoleArnFormat | Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name | 配置的RoleARN格式错误。 |
| 400 | Spark.Config.InvalidTimeZone | Unable to parse time zone configuration %s : %s | 时区配置错误。 |
| 400 | Spark.Config.MainAppFileNotExists | The main driver file is missing, [file] or [sqls] must be configured. | 主驱动文件缺失，必须保证file或者sqls配置不为空。 |
| 400 | Spark.Config.OSSPathAccessError | The configured OSS address %s cannot be accessed. | 配置的OSS路径无法访问。 |
| 400 | Spark.Config.OSSPathNotExists | The OSS address %s requested does not exist or the permissions are insufficient. | OSS路径不存在或当前用户无权限访问。 |
| 400 | Spark.Config.RoleArnVerifyFailed | RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s | RoleARN参数校验失败。 |
| 400 | Spark.Config.SecurityGroupNotFound | The security group in the configuration does not exist or cannot be accessed. %s. | 配置的资源组不存在或者因权限不足无法访问。%s。 |
| 400 | Spark.Config.VswitchNotFound | The vswitch in the configuration does not exist or cannot be accessed. %s. | 无法找到配置虚拟机交换机，或当前账号权限不足。%s。 |
| 400 | Spark.InvalidState | The object of the operation is in an invalid state: %s | 操作对象处于非合法状态。 |
| 400 | Spark.Log.InvalidState | Failed to obtain the logs of the Spark job %s in the %s state. | 无法获取指定Spark作业的日志。 |
| 403 | Spark.Forbidden | No permissions to access the resources: %s | 权限不足，拒绝访问相关资源。您当前申请访问的信息是：%s。 |
| 404 | Spark.App.ContentNotFound | The requested content %s of the Spark application is not found. | 找不到指定Spark作业的提交内容。 |
| 404 | Spark.App.NotFound | The Spark application %s is not found. | 未能找到输入的 Spark App。 |
| 404 | Spark.ObjectNotFound | The object is not found. More information: %s | 操作对象不存在。关联信息：%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 | Spark管控组件系统遇到错误，请提交工单，或联系值班工程师。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-27 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-06-28 | OpenAPI 错误码发生变更 | 查看变更详情 |