1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
本接口（DescribeSparkSessionBatchSQL）用于查询Spark SQL批任务运行状态
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSparkSessionBatchSQL。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BatchId | 是 | String | SparkSQL唯一标识 示例值：d3018ad4-9a7e-4f64-a3f4-f38507c69742 |
| CustomKey | 否 | String | 用户自定义主键, 若不为空，则按照该值查询 示例值：d39ijsd4-9a7e-4f64-a3f4-f38507c69742 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| State | Integer | 状态：0：运行中、1：成功、2：失败、3：取消、4：超时； 示例值：0 |
| Tasks | Array of BatchSqlTask | SQL子任务列表，仅展示运行完成的子任务，若某个任务运行失败，后续其它子任务不返回 注意：此字段可能返回 null，表示取不到有效值。 示例值：复杂类型数组 |
| Event | String | 非sql运行的异常事件信息，包含资源创建失败、调度异常，JOB超时等，正常运行下该Event值为空 示例值：init session fail |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取SparkSQL批任务运行状态
获取SparkSQL批任务运行状态
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSparkSessionBatchSqlLog
<公共请求参数>
{
"BatchId": "d3018ad4-9a7e-4f64-a3f4-fsjr37c69742"
}输出示例
{
"Response": {
"State": 0,
"Event": "",
"Tasks": [
{
"TaskId": "b8sdsdds-ekd4-4e5e-993e-e87js4fa21c1",
"ExecuteSQL": "select 1;",
"Message": "Task Success!"
}
],
"RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidSQL | SQL解析失败。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.BatchSQLTaskNotFound | 指定的交互式SQL任务不存在 |
| ResourceNotFound.SessionStateShuttingDown | Session正在关闭，请确认任务是否已经取消 |